jansson

Go to file

Petri Lehtinen 02beb90db3 Make it possible to forward declare struct json_t This allows e.g. to use json_t in a header file that doesn't include jansson.h: struct json_t; typedef struct json_t json_t; json_t foo(json_t bar);		2013-01-03 10:45:38 +02:00
doc	jansson 2.4	2012-09-23 12:52:41 +03:00
src	Make it possible to forward declare struct json_t	2013-01-03 10:45:38 +02:00
test	Really fix the off-by-one error in json_array_remove()	2012-12-04 21:20:59 +02:00
win32	Add vs2010 solution and project	2012-04-30 21:51:07 +08:00
.gitignore	Ignore *.exe	2012-03-21 14:03:46 +02:00
.travis.yml	travis: Run "make check" instead of "make test"	2012-12-28 14:22:24 +02:00
CHANGES	jansson 2.4	2012-09-23 12:52:41 +03:00
configure.ac	jansson 2.4	2012-09-23 12:52:41 +03:00
jansson.pc.in	Add pkg-config support	2010-01-07 19:30:20 +02:00
LICENSE	Update copyright notices for 2012	2012-03-20 20:55:55 +02:00
Makefile.am	Distribute win32 files	2012-09-23 12:52:40 +03:00
README.rst	Add travis build status image more cleverly	2012-12-28 15:30:15 +02:00

README.rst

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/