FGCOM/jansson
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
702 Commits 1 Branch 31 Tags 2 MiB
C 80.7%
CMake 11.8%
Shell 3.2%
Makefile 1.5%
M4 1.4%
Other 1.4%
19f33c0e71
Go to file
Joakim Söderberg 19f33c0e71 Add support for coverage/coveralls.io in cmake project. 
This adds support for http://coveralls.io/ to the cmake project. This can then be run via a new Travis job, which uploads json containing the coverage data to the website.

To use this, please login usin github at http://coveralls.io/ and enable the Jansson project. You can then get a nice percentage badge for code coverage after each Travis buid. Coveralls will also comment on pull request with coverage info.

To test and run it locally do:

```bash
$ mkdir build && cd build
$ cmake -DJANSSON_COVERALLS=ON -DCMAKE_BUILD_TYPE=Debug ..
$ cmake --build .                      # $ make
$ cmake --build . --target coveralls   # $ make coveralls
```

There is also another script that generates a local HTML page using lcov CodeCoverage.cmake which can be run using

```bash
$ make coverage
```

The required depdencies to run this are:
gcov
curl
lcov (is needed for the normal CodeCoverage script)
2014-12-12 23:57:01 +01:00
android Update copyrights for 2014 2014-01-28 09:16:05 +02:00
cmake Add support for coverage/coveralls.io in cmake project. 2014-12-12 23:57:01 +01:00
doc jansson 2.7 2014-10-02 13:10:45 +03:00
src Include jansson_config.h with quotes 2014-12-04 10:45:26 +02:00
test Use expr instead of $((...)) in shell scripts 2014-10-03 08:49:08 +03:00
.gitignore SmartOS build fix 2014-04-06 04:28:52 +00:00
.travis.yml Add support for coverage/coveralls.io in cmake project. 2014-12-12 23:57:01 +01:00
Android.mk Android.mk: Add -DHAVE_STDINT_H to LOCAL_CFLAGS 2014-07-31 07:50:31 +03:00
appveyor.yml Added Windows CI support with appveyor 2014-09-24 18:08:45 +02:00
CHANGES Update CHANGES for 2.7 2014-10-02 08:57:07 +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 Add support for coverage/coveralls.io in cmake project. 2014-12-12 23:57:01 +01:00
configure.ac jansson 2.7 2014-10-02 13:10:45 +03:00
jansson.pc.in Add pkg-config support 2010-01-07 19:30:20 +02:00
LICENSE Update copyrights for 2014 2014-01-28 09:16:05 +02:00
Makefile.am Don't use GNU-make specific export for global AM_CFLAGS 2014-08-26 15:01:13 +02:00
README.rst README: Documentation is hosted at RTD 2014-10-20 20:27:56 +03:00
release.sh Compress bz2 doc tarballs with bzip2 instead of gzip 2013-01-06 14:18:28 +02:00

README.rst 

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

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

Documentation is available at http://jansson.readthedocs.org/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/
.. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
.. _Sphinx: http://sphinx.pocoo.org/