jansson

mirror of https://github.com/akheron/jansson.git synced 2025-04-04 21:15:04 +00:00

C library for encoding, decoding and manipulating JSON data

c json

Find a file

Petri Lehtinen 3d5c0f46f1 Run Sphinx without the -W flag when building documentation In "make html", don't use the -W flag with Sphinx. This makes it possible to create the documentation with Sphinx 1.0 without errors, as the warning about using old-style C markup isn't turned to an error. Don't build documentation in "make check". Instead, add a new make target "check-doc" to build the documentation with the -W flag.		2010-09-06 20:46:15 +03:00
doc	Run Sphinx without the -W flag when building documentation	2010-09-06 20:46:15 +03:00
src	Make object_key_t portable	2010-08-12 21:35:23 +03:00
test	Remove the C++ interface	2010-06-12 22:45:49 +03:00
.gitignore	Merge branch '1.2'	2010-03-28 21:44:41 +03:00
CHANGES	Add a few missing changes to CHANGES for v1.3	2010-06-14 14:35:38 +03:00
configure.ac	Check for gcc before setting gcc specific CFLAGS	2010-08-12 21:00:09 +03:00
jansson.pc.in	Add pkg-config support	2010-01-07 19:30:20 +02:00
LICENSE	Remove the C++ interface	2010-06-12 22:45:49 +03: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/