/jansson/README.rst

http://github.com/nicolasff/webdis · ReStructuredText · 59 lines · 36 code · 23 blank · 0 comment · 0 complexity · 3382a622d989b1e09dfcebd9abf7a579 MD5 · raw file

  1. Jansson README
  2. ==============
  3. Jansson_ is a C library for encoding, decoding and manipulating JSON
  4. data. Its main features and design principles are:
  5. - Simple and intuitive API and data model
  6. - Comprehensive documentation
  7. - No dependencies on other libraries
  8. - Full Unicode support (UTF-8)
  9. - Extensive test suite
  10. Jansson is licensed under the `MIT license`_; see LICENSE in the
  11. source distribution for details.
  12. Compilation and Installation
  13. ----------------------------
  14. If you obtained a source tarball, just use the standard autotools
  15. commands::
  16. $ ./configure && make && make install
  17. If the source has been checked out from a Git repository, the
  18. ./configure script has to be generated fist. The easiest way is to use
  19. autoreconf::
  20. $ autoreconf -i
  21. To run the test suite, invoke::
  22. $ make check
  23. Documentation
  24. -------------
  25. Documentation is in the ``doc/`` subdirectory. It's written in
  26. reStructuredText_ with Sphinx_ annotations, so reading it in plain may
  27. be inconvenient. For this reason, prebuilt HTML documentation is
  28. available at http://www.digip.org/jansson/doc/.
  29. To generate HTML documentation yourself, invoke::
  30. make html
  31. and point your browser to ``doc/_build/html/index.html``. Sphinx_ is
  32. required to generate the documentation.
  33. .. _Jansson: http://www.digip.org/jansson/
  34. .. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
  35. .. _reStructuredText: http://docutils.sourceforge.net/rst.html
  36. .. _Sphinx: http://sphinx.pocoo.org/