summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 29 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..8fd9ccec
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+=================
+README for Sphinx
+=================
+
+Installing
+==========
+
+Use ``setup.py``::
+
+ python setup.py build
+ sudo python setup.py install
+
+
+Reading the docs
+================
+
+After installing::
+
+ cd doc
+ sphinx-build.py . .build
+ browser .build/index.html
+
+Or read them online at <http://sphinx.pocoo.org/>.
+
+
+Contributing
+============
+
+Send wishes, comments, patches, etc. to georg@python.org.