README.rst 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. Jansson README
  2. ==============
  3. .. image:: https://travis-ci.org/akheron/jansson.png
  4. :target: https://travis-ci.org/akheron/jansson
  5. .. image:: https://ci.appveyor.com/api/projects/status/lmhkkc4q8cwc65ko
  6. :target: https://ci.appveyor.com/project/akheron/jansson
  7. .. image:: https://coveralls.io/repos/akheron/jansson/badge.png?branch=master
  8. :target: https://coveralls.io/r/akheron/jansson?branch=master
  9. Jansson_ is a C library for encoding, decoding and manipulating JSON
  10. data. Its main features and design principles are:
  11. - Simple and intuitive API and data model
  12. - `Comprehensive documentation`_
  13. - No dependencies on other libraries
  14. - Full Unicode support (UTF-8)
  15. - Extensive test suite
  16. Jansson is licensed under the `MIT license`_; see LICENSE in the
  17. source distribution for details.
  18. Compilation and Installation
  19. ----------------------------
  20. If you obtained a source tarball, just use the standard autotools
  21. commands::
  22. $ ./configure
  23. $ make
  24. $ make install
  25. To run the test suite, invoke::
  26. $ make check
  27. If the source has been checked out from a Git repository, the
  28. ./configure script has to be generated first. The easiest way is to
  29. use autoreconf::
  30. $ autoreconf -i
  31. Documentation
  32. -------------
  33. Documentation is available at http://jansson.readthedocs.io/en/latest/.
  34. The documentation source is in the ``doc/`` subdirectory. To generate
  35. HTML documentation, invoke::
  36. $ make html
  37. Then, point your browser to ``doc/_build/html/index.html``. Sphinx_
  38. 1.0 or newer is required to generate the documentation.
  39. .. _Jansson: http://www.digip.org/jansson/
  40. .. _`Comprehensive documentation`: http://jansson.readthedocs.io/en/latest/
  41. .. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
  42. .. _Sphinx: http://sphinx.pocoo.org/