README.rst 1.4 KB

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