Go to file
2014-01-28 14:06:43 +01:00
android Update copyrights for 2014 2014-01-28 09:16:05 +02:00
cmake Update copyrights for 2014 2014-01-28 09:16:05 +02:00
doc Update copyrights for 2014 2014-01-28 09:16:05 +02:00
src Update copyrights for 2014 2014-01-28 09:16:05 +02:00
test Update copyrights for 2014 2014-01-28 09:16:05 +02:00
win32 Update copyrights for 2014 2014-01-28 09:16:05 +02:00
.gitignore Ignore *.exe 2012-03-21 14:03:46 +02:00
.travis.yml Add CMake build to Travis config. 2014-01-28 14:06:43 +01:00
Android.mk Create Android.mk, preconfigured jansson_config.h and CleanSpec.mk for Android-like build systems. 2013-03-27 17:31:05 -07:00
CHANGES Add JSON_ALLOW_NUL decoding flag for enabling NUL byte support 2013-09-30 10:45:02 +03:00
CleanSpec.mk Create Android.mk, preconfigured jansson_config.h and CleanSpec.mk for Android-like build systems. 2013-03-27 17:31:05 -07:00
CMakeLists.txt Make sure the private config is included. 2014-01-28 09:59:43 +01:00
configure.ac Renamed config.h -> jansson_private_config.h 2014-01-27 12:48:52 +01:00
jansson.pc.in Add pkg-config support 2010-01-07 19:30:20 +02:00
LICENSE Update copyrights for 2014 2014-01-28 09:16:05 +02:00
Makefile.am Include CMake specific files in release tarballs 2013-12-13 09:22:36 +02:00
README.rst Add travis build status image more cleverly 2012-12-28 15:30:15 +02:00
release.sh Compress bz2 doc tarballs with bzip2 instead of gzip 2013-01-06 14:18:28 +02:00

Jansson README
==============

.. image:: https://travis-ci.org/akheron/jansson.png
  :alt: Build status
  :target: https://travis-ci.org/akheron/jansson

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

To run the test suite, invoke::

   $ make check

If the source has been checked out from a Git repository, the
./configure script has to be generated first. The easiest way is to
use autoreconf::

   $ autoreconf -i


Documentation
-------------

Prebuilt HTML documentation is available at
http://www.digip.org/jansson/doc/.

The documentation source is in the ``doc/`` subdirectory. To generate
HTML documentation, invoke::

   $ make html

Then, point your browser to ``doc/_build/html/index.html``. Sphinx_
1.0 or newer is required to generate the documentation.


.. _Jansson: http://www.digip.org/jansson/
.. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
.. _Sphinx: http://sphinx.pocoo.org/