diff --git a/README.rst b/README.rst index 3533e937d..94c881c57 100644 --- a/README.rst +++ b/README.rst @@ -34,10 +34,23 @@ Linux / OS X First make sure that these things are installed - Python 2 (2.6.0 or better, Python 3 is not yet supported!) - - Sphinx (e.g. ``sudo yum install python-sphinx``), on Mac: ``sudo easy_install Sphinx`` - - Sphinx PHPDomain (e.g. ``sudo easy_install sphinxcontrib-phpdomain``) - - rst2pdf (e.g. ``sudo easy_install rst2pdf``) - - If you're on Arch Linux, the build script is called sphinx-build2 which will fail. Therefore you have to provide a link:: + - Sphinx + - Sphinx PHPDomain + - rst2pdf + +On Mac this can be done by executing + + sudo easy_install Sphinx sphinxcontrib-phpdomain rst2pdf + +On apt-get based distros this can be done by executing + + sudo apt-get install python-sphinx python-sphinxcontrib.phpdomain rst2pdf + +On yum based distros this can be done by executing + + sudo yum install python-sphinx rst2pdf + +If you're on Arch Linux, the build script is called sphinx-build2 which will fail. Therefore you have to provide a link:: sudo ln -s /usr/bin/sphinx-build2 /usr/bin/sphinx-build