Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MRG] simplify and clean up README #1124

Merged
merged 2 commits into from
Jul 25, 2020
Merged

[MRG] simplify and clean up README #1124

merged 2 commits into from
Jul 25, 2020

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Jul 25, 2020

Many updates --

  • remove HTML boilerplate at top of README
  • remove mention of Rust from user-focused installation (adjust README to make it clear that bioconda installs everything #983)
  • add cffi, numpy, matplotlib, scipy as documented requirements; remove ijson mention
  • remove bioconda setup instructions since -c is now specified explicitly
  • adjust language to point out that conda installs latest released version; link to releases page.
  • adjust one line description at top
  • adjust "who develops sourmash" a bit

Fixes #983
Addresses part of #1109

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@codecov
Copy link

codecov bot commented Jul 25, 2020

Codecov Report

Merging #1124 into master will increase coverage by 9.14%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1124      +/-   ##
==========================================
+ Coverage   83.89%   93.04%   +9.14%     
==========================================
  Files          98       74      -24     
  Lines        9124     5810    -3314     
==========================================
- Hits         7655     5406    -2249     
+ Misses       1469      404    -1065     
Flag Coverage Δ
#rusttests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/core/src/wasm.rs
src/core/src/index/sbt/mod.rs
src/core/src/ffi/mod.rs
src/core/src/ffi/signature.rs
src/core/src/index/storage.rs
src/core/src/cmd.rs
src/core/src/sketch/minhash.rs
src/core/src/ffi/nodegraph.rs
src/core/src/index/linear.rs
src/core/src/sketch/nodegraph.rs
... and 14 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 66fc0c2...a4a43c7. Read the comment docs.

@ctb
Copy link
Contributor Author

ctb commented Jul 25, 2020

ready for review & merge @luizirber

@luizirber luizirber merged commit 55f863e into master Jul 25, 2020
@luizirber luizirber deleted the update_README branch July 25, 2020 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

adjust README to make it clear that bioconda installs everything
2 participants