Skip to content

docs: install from Bioconda, with its version and downloads in the README - #31

Merged
Paururo merged 2 commits into
mainfrom
docs/bioconda-install
Oct 30, 2026
Merged

Paururo merged 2 commits into
mainfrom
docs/bioconda-install

Conversation

@Paururo

@Paururo Paururo commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

Recore is on Bioconda since bioconda/bioconda-recipes#70403 was merged: version 1.0.0 for linux-64, linux-aarch64, osx-64 and osx-arm64.

What changes

  • README badges: "bioconda v1.0.0" and "downloads", both linking to https://anaconda.org/bioconda/recore, in the same green and layout as pathotypr's, next to the CI, licence, Rust and DOI badges.
  • README install: one command first, conda install -c conda-forge -c bioconda recore, which brings minimap2 along. Building from source with cargo stays below it as the alternative.
  • Website: the Install section leads with the same command (a Bioconda card), and the source build stays beside it with the minimap2 tabs and cargo install. Checked in dark, light and at 390 px: no overflow, the tabs still switch, every command has its copy button.
  • SECURITY.md said there was no Bioconda package; it now supports it like the release it carries.
  • CHANGELOG: an Added entry.

Checked

  • The install command, run as written into a fresh environment on macOS arm64, installs recore 1.0.0 and minimap2 2.31 from Bioconda, and that recore runs the tutorial dataset with Rescued 11 / Matrix-corrected 8.
  • Both badges render ("bioconda: v1.0.0", "downloads: 77") in GitHub's own rendering of the README.
  • Locally fmt, clippy, the tests, the build, check_site.py --run-tutorial and the auto-merge gate check all pass.

…ADME

Recore is on Bioconda for Linux and macOS, Intel and ARM, so the README shows the Bioconda version and downloads and leads its install section with one conda command that brings minimap2 along. SECURITY.md now supports the Bioconda package instead of saying there is none.
@Paururo Paururo added documentation Improvements or additions to documentation ci Workflows, automation config, and the tools/ scripts labels Oct 30, 2026
The Install section now starts with the same one conda command as the README, which brings minimap2 along, and keeps minimap2 plus cargo as the source build beside it.
@Paururo
Paururo merged commit 8d4cfda into main Oct 30, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Workflows, automation config, and the tools/ scripts documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant