From f7734c3f0545f8fab0ca84dc00475d34cde98bea Mon Sep 17 00:00:00 2001 From: "C. Titus Brown" Date: Sat, 29 Dec 2018 10:38:28 -0800 Subject: [PATCH 1/2] update readme for conda install #552, pre-release version --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bd7b8815ef..7d127239f5 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ We have demo notebooks on binder that you can interact with: [![Binder](http://mybinder.org/badge.svg)](http://mybinder.org/repo/dib-lab/sourmash) -Sourmash is [published on JOSS](https://doi.org/10.21105/joss.00027). +Sourmash 1.0 is [published on JOSS](https://doi.org/10.21105/joss.00027); please cite that paper if you use sourmash (`doi: 10.21105/joss.00027`):. ---- @@ -26,7 +26,7 @@ combined with @ctb's love of whiskey. ([Sour mash](https://en.wikipedia.org/wiki/Sour_mash) is used in making whiskey.) -Authors: [C. Titus Brown](mailto:titus@idyll.org) ([@ctb](http://github.com/ctb)) and [Luiz C. Irber, Jr](mailto:sourmash@luizirber.org) ([@luizirber](http://github.com/luizirber)). +Primary authors: [C. Titus Brown](mailto:titus@idyll.org) ([@ctb](http://github.com/ctb)) and [Luiz C. Irber, Jr](mailto:sourmash@luizirber.org) ([@luizirber](http://github.com/luizirber)). sourmash is a product of the [Lab for Data-Intensive Biology](http://ivory.idyll.org/lab/) at the @@ -34,10 +34,22 @@ sourmash is a product of the ## Installation -We currently recommend installing the 2.0 pre-release series. -You can use pip to do that like so: +We recommend using bioconda to install sourmash: - pip install --pre sourmash +``` +conda install sourmash +``` +This will install the 2.0 pre-release series. + +You can also use pip to install the pre-release like so: + +``` +pip install --pre sourmash +``` + +A quickstart tutorial [is available](https://sourmash.readthedocs.io/en/latest/tutorials.html). + +### Requirements sourmash runs under both Python 2.7.x and Python 3.5+. The base requirements are screed and ijson, together with a C++ development @@ -85,4 +97,4 @@ Please see [the developer notes](doc/developer.md) for more information. ---- CTB -June 2018 +Dec 2018 From e21710b16b49fe6ad0f059d4dfc4252bc95f9fe8 Mon Sep 17 00:00:00 2001 From: "C. Titus Brown" Date: Sat, 29 Dec 2018 10:41:06 -0800 Subject: [PATCH 2/2] fix README for post-release; see #591 #552 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7d127239f5..778b994d06 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,12 @@ We recommend using bioconda to install sourmash: ``` conda install sourmash ``` -This will install the 2.0 pre-release series. +This will install the latest stable version of sourmash 2. -You can also use pip to install the pre-release like so: +You can also use pip to install sourmash: ``` -pip install --pre sourmash +pip install sourmash ``` A quickstart tutorial [is available](https://sourmash.readthedocs.io/en/latest/tutorials.html).