Add install information to doc homepage

mwaskom · May 29, 2014 · 89358e4 · 89358e4
1 parent f47eb88
commit 89358e4
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/doc/dependencies.rst b/doc/dependencies.rst
@@ -1,3 +1,5 @@
+.. _dependencies:
+
 Lyman Dependencies
 ==================
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -26,11 +26,26 @@ companion `zielger <https://github.com/mwaskom/ziegler>`_ webapp, which is
 tightly integrated with the lyman results and makes it very easy to understand
 what has happened with your data.
 
+Installing
+----------
+
+To install lyman, you can run
+
+    pip install lyman
+
+This will install the stable version. To get the development version, you
+should run
+
+   pip install git+git://github.com/mwaskom/lyman.git#egg=lyman
+
+However, there are a number of :ref:`dependencies <dependencies>` that should
+be installed first, in either case.
+
 To check out the code, please see the `github repository
-<https://github.com/mwaskom/lyman>`_
+<https://github.com/mwaskom/lyman>`_.
 
-Documentation Contents:
------------------------
+Documentation Contents
+----------------------
 
 .. toctree::
    :maxdepth: 2