GIT: Merge branch 'main' into JOSS

metagentools · Sep 26, 2024 · 7163b90 · 7163b90
2 parents 1bca251 + 692b927
commit 7163b90
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 36 deletions.
diff --git 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.
 

diff --git 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.