Adding install docs

bmorris3 · Oct 26, 2017 · 025d0b8 · 025d0b8
1 parent 7868878
commit 025d0b8
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,7 @@ You can view the
    :maxdepth: 2
    :caption: Contents:
 
+   install
    api
 
 

diff --git a/docs/install.rst b/docs/install.rst
@@ -0,0 +1,24 @@
+.. include:: references.txt
+
+.. _install:
+
+Installing aesop
+================
+
+Clone the ``aesop`` repository from GitHub, and go into the top-level ``aesop``
+directory::
+
+    git clone https://github.com/bmorris3/aesop
+    cd aesop
+
+Install ``aesop`` with::
+
+    python setup.py install
+
+You can ensure that the package was installed successfully by running the tests
+from a Python interpreter with the following commands:
+
+.. code-block:: python
+
+    >>> import aesop
+    >>> aesop.test()