organicmaps/jansson
13
Fork 0
mirror of https://github.com/akheron/jansson.git synced 2025-04-06 05:55:05 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions
C library for encoding, decoding and manipulating JSON data
122 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 f243930b68 json_load_file: Initialize the error struct properly 
Failing to do this has the effect that the error message is not
returned when the input file cannot be opened (e.g. if it doesn't
exist).

Thanks to Martin Vopatek for reporting.
2009-10-27 17:56:02 +02:00
doc jansson 1.1.1 2009-10-26 21:27:10 +02:00
src json_load_file: Initialize the error struct properly 2009-10-27 17:56:02 +02:00
test json_load_file: Initialize the error struct properly 2009-10-27 17:56:02 +02:00
.gitignore Remove config.h.in 2009-10-10 21:21:22 +03:00
CHANGES jansson 1.1.1 2009-10-26 21:27:10 +02:00
configure.ac jansson 1.1.1 2009-10-26 21:27:10 +02:00
LICENSE Add LICENSE and a copyright note to all sources 2009-07-30 11:32:24 +03:00
Makefile.am Build documentation in distcheck-hook 2009-10-25 00:20:23 +03:00
README.rst Enhance documentation 2009-10-19 21:56:11 +03: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

Python_ is required to run the tests.


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::

   cd doc/
   sphinx-build . .build/html

... and point your browser to ``.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
.. _Python: http://www.python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/