add README

zalando-stups · Apr 8, 2015 · 88a806a · 88a806a
1 parent 06ddf73
commit 88a806a
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -0,0 +1,18 @@
+===================
+STUPS Documentation
+===================
+
+First install the Sphinx_ documentation generator.
+
+.. code-block:: bash
+
+    $ pip install sphinx sphinx_rtd_theme
+
+
+Generate the Pequod HTML documentation locally:
+
+.. code-block:: bash
+
+    $ make html
+
+.. _Sphinx: http://sphinx-doc.org/