README.rst

   1 Jansson README
   2 ==============
   3
   4 Jansson_ is a C library for encoding, decoding and manipulating JSON
   5 data. Its main features and design principles are:
   6
   7 - Simple and intuitive API and data model
   8
   9 - Comprehensive documentation
  10
  11 - No dependencies on other libraries
  12
  13 - Full Unicode support (UTF-8)
  14
  15 - Extensive test suite
  16
  17 Jansson is licensed under the `MIT license`_; see LICENSE in the
  18 source distribution for details.
  19
  20
  21 Compilation and Installation
  22 ----------------------------
  23
  24 If you obtained a source tarball, just use the standard autotools
  25 commands::
  26
  27    $ ./configure && make && make install
  28
  29 If the source has been checked out from a Git repository, the
  30 ./configure script has to be generated fist. The easiest way is to use
  31 autoreconf::
  32
  33    $ autoreconf -i
  34
  35 To run the test suite, invoke::
  36
  37    $ make check
  38
  39
  40 Documentation
  41 -------------
  42
  43 Documentation is in the ``doc/`` subdirectory. It's written in
  44 reStructuredText_ with Sphinx_ annotations, so reading it in plain may
  45 be inconvenient. For this reason, prebuilt HTML documentation is
  46 available at http://www.digip.org/jansson/doc/.
  47
  48 To generate HTML documentation yourself, invoke::
  49
  50    make html
  51
  52 and point your browser to ``doc/_build/html/index.html``. Sphinx_ is
  53 required to generate the documentation.
  54
  55
  56 .. _Jansson: http://www.digip.org/jansson/
  57 .. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
  58 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
  59 .. _Sphinx: http://sphinx.pocoo.org/