Jansson README

Jansson is a C library for encoding, decoding and manipulating JSON data. Its main features and design principles are:

• Simple and intuitive API and data model
• Good documentation
• Full Unicode support (UTF-8)
• Extensive test suite
• No dependencies on other libraries

Jansson is licensed under the MIT license; see LICENSE in the source distribution for details.

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

To run the test suite, invoke:

$ make check

Python is required to run the tests.

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/.

To generate HTML documentation yourself, invoke:

cd doc/
sphinx-build . .build/html

... and point your browser to .build/html/index.html. Sphinx is required to generate the documentation.