Go to file
Joakim Söderberg 52a8072727 Rename the CMakeModules directory to simply cmake.
This is more consistent with the other directories in the project.
2013-03-07 16:12:08 +01:00
cmake Rename the CMakeModules directory to simply cmake. 2013-03-07 16:12:08 +01:00
doc Set master for 2.5 development mode 2012-09-23 13:41:40 +03:00
src Consolidated the CMake project. 2013-03-07 16:11:07 +01:00
test Always use LF as line ending so that we don't get any problems with line 2013-03-07 16:12:07 +01: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 Enable -Werror in Travis builds 2013-02-04 09:55:34 +02:00
CHANGES jansson 2.4 2012-09-23 12:52:41 +03:00
CMakeLists.txt Consolidated the CMake project. 2013-03-07 16:11:07 +01:00
config.h.cmake Consolidated the CMake project. 2013-03-07 16:11:07 +01:00
configure.ac Set master for 2.5 development mode 2012-09-23 13:41:40 +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 Don't use -Werror by default 2013-02-04 09:51:42 +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/