From a207093f1490a308e264f44180d4a4b7433370d5 Mon Sep 17 00:00:00 2001 From: Vijini Mallawaarachchi Date: Thu, 26 Sep 2024 14:43:12 +0930 Subject: [PATCH 1/2] DOC: update DEMO --- DEMO.md | 38 ++------------------------------------ 1 file changed, 2 insertions(+), 36 deletions(-) diff --git a/DEMO.md b/DEMO.md index 6f51e69..147fed9 100644 --- a/DEMO.md +++ b/DEMO.md @@ -1,42 +1,8 @@ # GraphBin-Tk Demo -## Setup GraphBin-Tk +## Installing GraphBin-Tk -First, let's download GraphBin-Tk. Make sure you have `git` installed. - -```shell -git clone https://github.com/metagentools/gbintk.git -``` - -Now move in to the 'gbintk' directory. - -```shell -cd gbintk -``` - -Let's create an environment for gbintk using the provided `environment.yml` file. Make sure you have `conda`` installed. - -```shell -conda env create -f environment.yml -``` - -Activate the environment. - -```shell -conda activate gbintk -``` - -Install using `flit` - -```shell -flit install -``` - -Test your installation. - -```shell -gbintk --help -``` +Please follow the instructions provided in the [README](https://github.com/metagentools/gbintk/blob/main/README.md) to install `gbintk`. Now we are all set for the demo. From 692b92726f4f9a89c9efe4bb419602486c6764d3 Mon Sep 17 00:00:00 2001 From: Vijini Mallawaarachchi Date: Thu, 26 Sep 2024 14:45:51 +0930 Subject: [PATCH 2/2] DOC: update README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 046a42e..0357428 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,8 @@ Commands: evaluate Evaluate the binning results given a ground truth ``` +Please refer to [DEMO.md](https://github.com/metagentools/gbintk/blob/main/DEMO.md) for example code to run using test data provided. For further details on available subcommands and examples, please refer to the documentation hosted at **[Read the Docs](https://gbintk.readthedocs.io/en/latest/)**. + ## Citation If you use GraphBin-Tk in your work, please cite the relevant tools.