Go to file
2022-04-28 17:36:54 +02:00
.github/workflows Fix and simplify coveralls reporting 2021-01-26 22:07:32 +02:00
android Update copyrights for 2016 2016-09-18 14:17:03 +03:00
cmake Fix and simplify coveralls reporting 2021-01-26 22:07:32 +02:00
doc jansson 2.14 2021-09-09 21:18:40 +03:00
examples C11 %zd is bit overkill here. Especially requiring conditional compile. 2020-11-06 15:51:14 +11:00
scripts Fix clang-format version checking 2019-10-21 08:56:03 +03:00
src value, pack: use key length from json_object iternals 2021-11-20 22:47:14 +03:00
test tests: add some cases in fixed size test 2021-11-20 22:57:10 +03:00
.clang-format Tweak clang-format configuration a bit 2019-10-21 08:56:03 +03:00
.gitignore Run clang-format with make check 2019-10-21 08:56:03 +03:00
Android.mk Android.mk: Add -DHAVE_STDINT_H to LOCAL_CFLAGS 2014-07-31 07:50:31 +03:00
appveyor.yml Also build on Visual Studio 2019 on AppVeyor 2021-01-14 21:12:02 +02:00
CHANGES jansson 2.14 2021-09-09 21:18:40 +03:00
CleanSpec.mk Create Android.mk, preconfigured jansson_config.h and CleanSpec.mk for Android-like build systems. 2013-03-27 17:31:05 -07:00
CMakeLists.txt Fix overwriting linker flags 2022-04-28 17:36:54 +02:00
configure.ac jansson 2.14 2021-09-09 21:18:40 +03:00
CONTRIBUTING.md Create CONTRIBUTING.md 2021-09-12 18:37:43 +03:00
jansson.pc.in build: Use Autoconf macro @includedir@ for jansson.pc. 2017-04-12 22:36:58 +02:00
LICENSE jansson 2.13 2020-05-05 07:07:16 +03:00
Makefile.am add scripts directory to EXTRA_DIST 2020-05-06 18:01:19 +08:00
README.rst Add some links to README 2021-11-22 16:30:12 +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://github.com/akheron/jansson/workflows/tests/badge.svg
  :target: https://github.com/akheron/jansson/actions

.. image:: https://ci.appveyor.com/api/projects/status/lmhkkc4q8cwc65ko
  :target: https://ci.appveyor.com/project/akheron/jansson

.. image:: https://coveralls.io/repos/akheron/jansson/badge.png?branch=master
  :target: https://coveralls.io/r/akheron/jansson?branch=master

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

You can download and install Jansson using the `vcpkg <https://github.com/Microsoft/vcpkg/>`_ dependency manager:

.. code-block:: bash

    git clone https://github.com/Microsoft/vcpkg.git
    cd vcpkg
    ./bootstrap-vcpkg.sh
    ./vcpkg integrate install
    vcpkg install jansson

The Jansson port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please `create an issue or pull request <https://github.com/Microsoft/vcpkg/>`_ on the vcpkg repository.

If you obtained a `source tarball`_ from the "Releases" section of the main
site 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
-------------

Documentation is available at http://jansson.readthedocs.io/en/latest/.

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.


Community
---------

* `Documentation <http://jansson.readthedocs.io/en/latest/>`_
* `Issue tracker <https://github.com/akheron/jansson/issues>`_
* `Mailing list <http://groups.google.com/group/jansson-users>`_
* `Wiki <https://github.com/akheron/jansson/wiki>`_ contains some development documentation

.. _Jansson: http://www.digip.org/jansson/
.. _`Comprehensive documentation`: http://jansson.readthedocs.io/en/latest/
.. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
.. _`source tarball`: http://www.digip.org/jansson#releases
.. _Sphinx: http://sphinx.pocoo.org/