Repository navigation
Conversation
marcelm
force-pushed
the
readme-streamline
branch
3 times, most recently
from
November 13, 2026 20:02
e26fa3e to
caf8864
Compare
marcelm
had a problem deploying
to
github-pages
November 13, 2026 20:02 — with 
GitHub Actions
Failure
GitHub Actions
Failure
Restructure the README: a "Getting started" block with the common commands up front, short installation instructions, and a Usage section with one subsection per use case (short-read mapping, variant calling, long-read mapping, metagenomic abundance estimation). Background, command-line options, read profiles, index files, explanation of the algorithm, Python bindings and evaluation are moved unchanged to a new manual.md, which the README links to.
marcelm
force-pushed
the
readme-streamline
branch
from
November 13, 2026 20:07
caf8864 to
0cdf8e9
Compare
marcelm
had a problem deploying
to
github-pages
November 13, 2026 20:07 — with
GitHub Actions
Failure
GitHub Actions
Failure
Collaborator
|
As a test, I have split up the detailed documentation (that this PR originally moved to If we want to do this, the MyST documentation could be hosted on GitHub Pages or Read the Docs. Since GitHub Pages are not activated for this repo, I created a preview in my fork: https://marcelm.github.io/strobealign/ (It looks a bit boring at the moment; we should have an image or so on the introductory page.) |
This branch had an error being deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Shortens the README (308 → 137 lines) with a “Getting started” block up front and one Usage subsection per use case: short reads, variant calling, long reads, and abundance estimation.
Everything else moves unchanged to a new manual.md.
Depends on #677 (--exclude-alt). Long-read mapping is a TODO for now.