DOC: Update docs and README

metagentools · Apr 22, 2024 · 5b3ede7 · 5b3ede7
1 parent 91397b4
commit 5b3ede7
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -25,19 +25,19 @@ GraphBin2 is an extension of [GraphBin](https://github.com/Vini2/GraphBin) which
 ### Downloading GraphBin2
 You can download the latest release of GraphBin2 from [Releases](https://github.com/Vini2/GraphBin2/releases) or clone the GraphBin2 repository to your machine.
 
-```
+```bash
 git clone https://github.com/Vini2/GraphBin2.git
 ```
 
 If you have downloaded a release, you will have to extract the files using the following command.
 
-```
+```bash
 unzip [file_name].zip
 ```
 
 Now go in to the GraphBin2 folder using the command
 
-```
+```bash
 cd GraphBin2/
 ```
 
@@ -47,24 +47,26 @@ We recommend that you use [Conda](https://docs.conda.io/en/latest/) to run Graph
 
 Once you have installed Conda, make sure you are in the GraphBin2 folder. Now run the following commands to create a Conda environment and activate it to run GraphBin2.
 
-```
+```bash
 conda env create -f environment.yml
 conda activate graphbin2
 ```
 
 Now install GraphBin2 using the following command.
 
-```
+```bash
 flit install
 ```
 
-Now you are ready to run GraphBin2.
+### Test the setup
 
-If you want to switch back to your normal environment, run the following command.
+After installing, run the following command to ensure that GraphBin2 is working.
 
+```bash
+graphbin2 -h
 ```
-conda deactivate
-```
+
+Now you are ready to run GraphBin2.
 
 
 ## Citation

diff --git a/docs/install.md b/docs/install.md
@@ -8,7 +8,7 @@ You can download the latest release of GraphBin2 from [Releases](https://github.
 git clone https://github.com/Vini2/GraphBin2.git
 ```
 
-If you have downloaded the latest release, you will have to extract the files using the following command.
+If you have downloaded a release, you will have to extract the files using the following command.
 
 ```bash
 unzip [file_name].zip
@@ -37,10 +37,12 @@ Now install GraphBin2 using the following command.
 flit install
 ```
 
-Now you are ready to run GraphBin2.
+## Test the setup
 
-If you want to switch back to your normal environment, run the following command.
+After installing, run the following command to ensure that GraphBin2 is working.
 
 ```bash
-conda deactivate
-```
+graphbin2 -h
+```
+
+Now you are ready to run GraphBin2.