From a7cf24ecb8f9955e41e3c01259e9997e4d010fe0 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Tue, 14 Jul 2015 11:14:15 +0200 Subject: [PATCH] [IMP] README bits --- README.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 8756b01fe..f8a96dcc7 100644 --- a/README.rst +++ b/README.rst @@ -13,13 +13,18 @@ Building requirements: $ sphinx-build --version -After checking out, at the root of the documentation just type + See `the sphinx documentation `_ + for local installation instructions. +* `git `_ +* clone this repository using git, then at the root of the repository, + in a console, -.. code-block:: console + .. code-block:: console - $ make html + $ make html -the HTML content will be built to ``_build/html/index.html``. + this should compile the documentation to HTML, and put the generated + HTML in ``_build/html/index.html``. Contributions =============