jansson

Go to file

Petri Lehtinen 2ae279e0d4 test/run-suites: Be less picky when searching for tests This is to better catch distribution errors. It's easier to notice that run-tests fails than to notice that one of many test suites is silently skipped.		2010-01-21 21:49:04 +02:00
doc	Remove CHANGES preprocessing, as it didn't work with VPATH builds	2010-01-21 20:53:05 +02:00
src	Fix memory leaks in json_*_deep_copy()	2010-01-10 21:01:07 +02:00
test	test/run-suites: Be less picky when searching for tests	2010-01-21 21:49:04 +02:00
.gitignore	Add pkg-config support	2010-01-07 19:30:20 +02:00
CHANGES	Remove CHANGES preprocessing, as it didn't work with VPATH builds	2010-01-21 20:53:05 +02:00
configure.ac	Merge branch '1.1'	2010-01-17 13:57:20 +02:00
jansson.pc.in	Add pkg-config support	2010-01-07 19:30:20 +02:00
LICENSE	Add LICENSE and a copyright note to all sources	2009-07-30 11:32:24 +03:00
Makefile.am	Merge branch '1.1'	2010-01-17 13:57:20 +02:00
README.rst	Update documentation	2010-01-12 21:29:16 +02:00

README.rst

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

- Comprehensive documentation

- No dependencies on other libraries

- Full Unicode support (UTF-8)

- Extensive test suite

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


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::

   make html

and point your browser to ``doc/_build/html/index.html``. Sphinx_ is
required to generate the documentation.


.. _Jansson: http://www.digip.org/jansson/
.. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/