README.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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
  17. $ make
  18. $ make install
  19. To run the test suite, invoke::
  20. $ make check
  21. If the source has been checked out from a Git repository, the
  22. ./configure script has to be generated first. The easiest way is to
  23. use autoreconf::
  24. $ autoreconf -i
  25. Documentation
  26. -------------
  27. Prebuilt HTML documentation is available at
  28. http://www.digip.org/jansson/doc/.
  29. The documentation source is in the ``doc/`` subdirectory. To generate
  30. HTML documentation, invoke::
  31. $ make html
  32. Then, point your browser to ``doc/_build/html/index.html``. Sphinx_
  33. 1.0 or newer is required to generate the documentation.
  34. .. _Jansson: http://www.digip.org/jansson/
  35. .. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
  36. .. _Sphinx: http://sphinx.pocoo.org/
粤ICP备19079148号