X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=README.rst;h=46071257582a15963c46a8c5eafaa55d34ff3a95;hb=refs%2Fheads%2Fmaster;hp=ebd394135689d3d2beeb8b07637bcb986e7600bb;hpb=cd96049d1061ff7095200bf460180554015cf32f;p=jansson.git diff --git a/README.rst b/README.rst index ebd3941..4607125 100644 --- a/README.rst +++ b/README.rst @@ -24,40 +24,36 @@ Compilation and Installation If you obtained a source tarball, just use the standard autotools commands:: - $ ./configure && make && make install - -If the source has been checked out from a Git repository, the -./configure script has to be generated fist. The easiest way is to use -autoreconf:: - - $ autoreconf -i + $ ./configure + $ make + $ make install To run the test suite, invoke:: $ make check -Python_ is required to run the tests. +If the source has been checked out from a Git repository, the +./configure script has to be generated first. The easiest way is to +use autoreconf:: + + $ autoreconf -i Documentation ------------- -Documentation is in the ``doc/`` subdirectory. It's written in -reStructuredText_ with Sphinx_ annotations, so reading it in plain may -be inconvenient. For this reason, prebuilt HTML documentation is -available at http://www.digip.org/jansson/doc/. +Prebuilt HTML documentation is available at +http://www.digip.org/jansson/doc/. -To generate HTML documentation yourself, invoke:: +The documentation source is in the ``doc/`` subdirectory. To generate +HTML documentation, invoke:: - cd doc/ - sphinx-build . .build/html + $ make html -... and point your browser to ``.build/html/index.html``. Sphinx_ is -required to generate the documentation. +Then, point your browser to ``doc/_build/html/index.html``. Sphinx_ +1.0 or newer is required to generate the documentation. .. _Jansson: http://www.digip.org/jansson/ .. _`MIT license`: http://www.opensource.org/licenses/mit-license.php -.. _Python: http://www.python.org/ -.. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Sphinx: http://sphinx.pocoo.org/