X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=ef81cf5c62255fdd20765380cd9c92898e5b6671;hb=4381288eeb792adb3672ef747013c02815fa760a;hp=eb05a28441f8bb27bab0be603111494d2d4f604e;hpb=d243892ad9717d0d1cbb0dbc941b229b24a7f09e;p=ibg.git diff --git a/README.md b/README.md index eb05a28..ef81cf5 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,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: