Include documentation folder, README.

[pithos] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..9541ad2
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+Documentation
+-------------
+
+To build the documentation you need to have Sphinx installed:
+http://sphinx.pocoo.org/
+
+Run:
+    python setup.py build_sphinx
+
+The documentation will be built in the doc/build/html directory.
+
+Also run:
+    python setup.py build_sphinx -b text
+
+Then find the plain text version of the docs in doc/build/text.
+
+Running the server
+------------------
+
+Enter the pithos dir and run:
+    python manage.py runserver
+
+This server is useful during development, but should not be used for deployment.