jansson

Go to file

Petri Lehtinen b397711a66 Check documentation in make distcheck It seems that the only way to do this is to use the dvi make target, as it's built in make distcheck after running configure.		2011-03-10 21:24:45 +02:00
doc	jansson 2.0	2011-02-28 20:46:14 +02:00
src	jansson 2.0	2011-02-28 20:46:14 +02:00
test	Fix packing of invalid UTF-8 strings	2011-02-27 21:34:12 +02:00
.gitignore	Move site configuration to jansson_config.h	2010-08-10 22:16:55 +03:00
CHANGES	jansson 2.0	2011-02-28 20:46:14 +02:00
configure.ac	jansson 2.0	2011-02-28 20:46:14 +02: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	Check documentation in make distcheck	2011-03-10 21:24:45 +02:00
README.rst	Update README	2011-02-27 21:09:55 +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

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 fist. 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/