/jansson/README.rst

 1Jansson README
 2==============
 3
 4Jansson_ is a C library for encoding, decoding and manipulating JSON
 5data. 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
17Jansson is licensed under the `MIT license`_; see LICENSE in the
18source distribution for details.
19
20
21Compilation and Installation
22----------------------------
23
24If you obtained a source tarball, just use the standard autotools
25commands::
26
27   $ ./configure && make && make install
28
29If 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
31autoreconf::
32
33   $ autoreconf -i
34
35To run the test suite, invoke::
36
37   $ make check
38
39
40Documentation
41-------------
42
43Documentation is in the ``doc/`` subdirectory. It's written in
44reStructuredText_ with Sphinx_ annotations, so reading it in plain may
45be inconvenient. For this reason, prebuilt HTML documentation is
46available at http://www.digip.org/jansson/doc/.
47
48To generate HTML documentation yourself, invoke::
49
50   make html
51
52and point your browser to ``doc/_build/html/index.html``. Sphinx_ is
53required 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/