added installation page

GoekeLab · May 25, 2020 · 7654e15 · 7654e15
1 parent 7aeda10
commit 7654e15
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,8 +20,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'xpore'
-copyright = '2019, Naruemon Pratanwanich (Ploy)'
-author = 'Naruemon Pratanwanich (Ploy)'
+copyright = '2019, Ploy N. Pratanwanich'
+author = 'Ploy N. Pratanwanich'
 
 # The short X.Y version
 version = ''
@@ -157,4 +157,4 @@
 ]
 
 
-# -- Extension configuration -------------------------------------------------
+# -- Extension configuration -------------------------------------------------
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,8 +7,9 @@ Welcome to xpore's documentation!
 =================================
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :hidden:
+
+   installation
 
 
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -0,0 +1,15 @@
+.. _installation:
+
+Installation
+=======================
+
+xPore requires [Python3](https://www.python.org) to run.
+
+To install our xpore package and its dependencies, run
+
+```sh
+$ python setup.py install
+$ pyensembl install --release 91 --species homo_sapiens
+```
+
+