DOC Mention supported Python versions

BigDataBiology · Jun 17, 2020 · f316a27 · f316a27
1 parent f751b07
commit f316a27
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -7,25 +7,16 @@ Command line tool to query the Global Microbial Gene Catalog (GMGC).
 
 ## Install
 
-Install from source
+GMGC-mapper runs on Python 3.6-3.8 and requires
+[prodigal](https://github.com/hyattpd/Prodigal) to be available for genome
+mode.
+
+### Install from source
 
 ```bash
 python setup.py install
 ```
 
-GMGC-mapper requires [prodigal](https://github.com/hyattpd/Prodigal) to be
-available for genome mode.
-
-
-## Parameters
-
-* `-i/--input`: path to the input genome file(.fasta/.gz/.bz2).
-
-* `-o/--output`: Output directory (will be created if non-existent).
-
-* `--nt-genes`: path to the input DNA gene file(.fasta/.gz/.bz2).
-
-* `--aa-genes`: path to the input Protein gene file(.fasta/.gz/.bz2).
 
 ## Examples
 
@@ -66,3 +57,13 @@ For more details, [read the
 docs](https://gmgc-mapper.readthedocs.io/en/latest/output/). A description of
 the outputs is also written to output folder for convenience.
 
+## Parameters
+
+* `-i/--input`: path to the input genome file(.fasta/.gz/.bz2).
+
+* `-o/--output`: Output directory (will be created if non-existent).
+
+* `--nt-genes`: path to the input DNA gene file(.fasta/.gz/.bz2).
+
+* `--aa-genes`: path to the input Protein gene file(.fasta/.gz/.bz2).
+
diff --git a/docs/install.md b/docs/install.md
@@ -1,9 +1,10 @@
 # Install
 
-GMGC-mapper requires [prodigal](https://github.com/hyattpd/Prodigal). You need
-to install prodigal first and add it into your system path.
+GMGC-mapper runs on Python 3.6-3.8 and requires
+[prodigal](https://github.com/hyattpd/Prodigal). You need to install prodigal
+first and add it into your system path.
 
-Install from source
+### Installing from source
 
 ```bash
 python setup.py install