jansson

Go to file

Petri Lehtinen ef13fb9189 Tweak the default validation behaviour of the unpack API Now, by default, unpacking doesn't check that all array and object items are accessed. The check can be enabled globally by using the JSON_STRICT flag (formerly JSON_UNPACK_ONLY), or on a per-value basis by using the new '!' format character. The '*' format character is still available to disable the global check on a per-value basis.		2011-01-29 21:38:07 +02:00
doc	Tweak the default validation behaviour of the unpack API	2011-01-29 21:38:07 +02:00
src	Tweak the default validation behaviour of the unpack API	2011-01-29 21:38:07 +02:00
test	Expand the pack/unpack API, implement unpack flags	2011-01-25 10:02:27 +02:00
.gitignore	Move site configuration to jansson_config.h	2010-08-10 22:16:55 +03:00
CHANGES	Add a few missing changes to CHANGES for v1.3	2010-06-14 14:35:38 +03:00
configure.ac	Merge branch '1.3'	2010-08-14 21:02:08 +03:00
jansson.pc.in	Add pkg-config support	2010-01-07 19:30:20 +02:00
LICENSE	Update copyright notices for 2011	2011-01-22 13:43:14 +02:00
Makefile.am	Run Sphinx without the -W flag when building documentation	2010-09-06 20:46:15 +03: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/