Go to file
Petri Lehtinen 79075d5393
Merge pull request #498 from AllenX2018/fix-issue441
fix issue #441: remove strtod definition in strconv.c
2019-10-21 08:51:36 +03:00
android Update copyrights for 2016 2016-09-18 14:17:03 +03:00
cmake Merge pull request #502 from AllenX2018/fix-issue453 2019-10-17 08:09:20 +03:00
doc Merge branch 'master' into fix-issue281 2019-10-17 13:37:33 +03:00
examples jansson 2.8 2016-08-30 21:09:28 +03:00
src Merge pull request #498 from AllenX2018/fix-issue441 2019-10-21 08:51:36 +03:00
test Merge branch 'master' into fix-issue281 2019-10-17 13:37:33 +03:00
.gitignore CMake variable to number comparison changed to provide meaningful error 2018-05-18 10:35:05 +02:00
.travis.yml Ensure OSS fuzz travis builds work for PRs 2019-07-24 10:43:03 +01:00
Android.mk Android.mk: Add -DHAVE_STDINT_H to LOCAL_CFLAGS 2014-07-31 07:50:31 +03:00
appveyor.yml Also build with VS 2017 in appveyor 2018-05-07 08:39:49 +03:00
CHANGES CHANGES: Fix 2.12 release date 2018-11-26 10:59:06 +02: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 various typos 2019-09-20 13:35:56 -04:00
configure.ac One byte fix to fix OSS Fuzz AFL support 2019-07-22 11:23:54 +01:00
jansson.pc.in build: Use Autoconf macro @includedir@ for jansson.pc. 2017-04-12 22:36:58 +02:00
LICENSE Update copyright for 2018 2018-07-14 16:34:33 -04:00
Makefile.am Move ossfuzz directory and use Makefile.am 2019-07-19 09:52:37 +01:00
README.rst Add vcpkg installation instructions 2019-09-26 16:54:02 -07: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
  :target: https://travis-ci.org/akheron/jansson
  
.. 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.


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