added installation instructions

tomlouden · Aug 10, 2016 · ce1a1ff · ce1a1ff
1 parent 1f7f635
commit ce1a1ff
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,6 +12,7 @@ Contents:
    :maxdepth: 2
 
    intro
+   installation
 
 
 Indices and tables

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,34 @@
+
+Installation
+============
+pip
+---
+You can install ``batman`` with pip (recommended):
+
+::
+
+	$ pip install batman-package
+
+From source
+-----------
+You can also install directly from source. The most current `stable release <https://pypi.python.org/pypi/batman-package/>`_ is up on PyPI and the `development version <https://github.com/lkreidberg/batman>`_ can be found on GitHub.
+
+
+Unpack the distribution with ``tar -xvf`` and navigate to the source root directory.  To install, run the setup script:
+
+::
+
+   $ sudo python setup.py install
+
+Note that you'll need to ``cd`` out of the source directory **before** you can import ``batman``.
+
+
+Tests
+-----
+To check whether the install is working, I recommend running a few basic tests with:
+
+::
+
+	$ python -c 'import batman; batman.test()'
+
+