Add RTD link to README.
[ibg.git] / README.md
index eb05a28441f8bb27bab0be603111494d2d4f604e..f2c7b151101483914c339c12764b9ce3ba0f8bf8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Inform Beginner's Guide
 Introduction
 ------------
 
-This repository contains the sources for the
+This repository contains the sources for an updated version of the
 [Inform Beginner's Guide](http://www.firthworks.com/roger/IBG.html),
 henceforth known as the IBG.  This version is in a new source format that's
 more version-control and contributor-friendly:
@@ -27,6 +27,9 @@ the 4th edition will be prepared.  The rationale for a 4th edition is:
 * Some old web links have gone away, to be replaced by new and better
   ones.
 
+If you want a preview of how the online HTML version of the new guide
+looks, you can find it [here](http://inform-beginners-guide.readthedocs.org).
+
 Building from source
 --------------------
 
@@ -35,12 +38,15 @@ As well as these document sources, you will need:
 * Sphinx.  You can find the complete installation instructions
   [here](http://www.sphinx-doc.org/en/stable/install.html).
 
-* Sphinx makes use of [Blockdiag](https://pypi.python.org/pypi/blockdiag)
-  for some of the diagrams; you'll need that too.
+* [Blockdiag](https://pypi.python.org/pypi/blockdiag) is used for some of
+  the diagrams.
+
+* To create the HTML version, you'll need a recent (>=0.7.8) version of the
+  [Alabaster](https://pypi.python.org/pypi/alabaster) theme.
 
 If you have `pip`, this command will be all you need:
 
-    pip install sphinx blockdiag
+    pip install -U sphinx blockdiag alabaster
 
 After you have everything installed, you can build the HTML version of the
 guide from a command prompt, like this: