organicmaps/jansson
13
Fork 0
mirror of https://github.com/akheron/jansson.git synced 2025-04-08 06:43:11 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions
C library for encoding, decoding and manipulating JSON data
258 commits 32 branches 32 tags 3.4 MiB
C 86.2%
CMake 8.5%
Shell 2.1%
M4 1.1%
Makefile 1.1%
Other 1%
Find a file
Petri Lehtinen 6e3ca5c45c Clarify the documentation 
Couple some string and number information from the RFC conformance
chapter in the API reference, and refer to the RFC conformance chapter
from API reference for more information.

Also, state more clearly that a JSON text must have an array or object
as the top-level value, and better document the string comparison
performed by json_equal().
2010-06-16 21:34:10 +03:00
doc Clarify the documentation 2010-06-16 21:34:10 +03:00
src jansson 1.3 2010-06-13 20:37:33 +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 configure.ac: Remove unneeded AC_PROG_CXX 2010-06-14 22:30:15 +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 Merge branch '1.1' 2010-01-17 13:57:20 +02: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/