summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-09-20 21:09:33 +0200
committerGeorg Brandl <georg@python.org>2014-09-20 21:09:33 +0200
commit3b0ab48230effa1345d0772f087a3e4b0cd6f06f (patch)
treebb8b4d999229aa7ca7d8cded9835996314d81c85 /README.rst
parent6d4011a6bc4ae0848da21c92e5a9a190141e8f1b (diff)
downloadsphinx-3b0ab48230effa1345d0772f087a3e4b0cd6f06f.tar.gz
Very short introduction in README
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 452f59db..ae92a2ce 100644
--- a/README.rst
+++ b/README.rst
@@ -2,6 +2,9 @@
README for Sphinx
=================
+This is the Sphinx documentation generator, see http://sphinx-doc.org/.
+
+
Installing
==========
@@ -17,7 +20,7 @@ Reading the docs
After installing::
cd doc
- sphinx-build . _build/html
+ make html
Then, direct your browser to ``_build/html/index.html``.