diff options
author | Petri Lehtinen <petri@digip.org> | 2009-08-02 21:26:37 +0300 |
---|---|---|
committer | Petri Lehtinen <petri@digip.org> | 2009-08-13 18:38:03 +0300 |
commit | 251722d499cc2ec0962580f6cf60ed0acdc5330e (patch) | |
tree | b74df0c776736a0a104431468a6c5d9e207751ac /README.rst | |
parent | 0428f48d19b5206547d9b4ea010ff41eb5e5d92d (diff) | |
download | jansson-251722d499cc2ec0962580f6cf60ed0acdc5330e.zip jansson-251722d499cc2ec0962580f6cf60ed0acdc5330e.tar.gz jansson-251722d499cc2ec0962580f6cf60ed0acdc5330e.tar.bz2 |
Add README and API reference
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..66243eb --- /dev/null +++ b/README.rst @@ -0,0 +1,63 @@ +Jansson README +============== + +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 + +- Good documentation + +- Full Unicode support (UTF-8) + +- Extensive test suite + +- No dependencies on other libraries + +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 + +If the source has been checked out from a Git repository, the +./configure script has to be generated fist. The easiest way is to use +autoreconf:: + + $ autoreconf -i + +To run the test suite, invoke:: + + $ make check + +Python_ is required to run the tests. + + +Documentation +------------- + +Documentation is in the ``doc/`` subdirectory. It's written in +reStructuredText_ with Sphinx_ annotations, so reading it in plain may +be inconvenient. For this reason, prebuilt HTML documentation is +available at http://www.digip.org/jansson/doc/. + +To generate HTML documentation yourself, invoke:: + + cd doc/ + sphinx-build . .build/html + +... and point your browser to ``.build/html/index.html``. Sphinx_ is +required to generate the documentation. + + +.. _Jansson: http://www.digip.org/jansson/ +.. _`MIT license`: http://www.opensource.org/licenses/mit-license.php +.. _Python: http://www.python.org/ +.. _reStructuredText: http://docutils.sourceforge.net/rst.html +.. _Sphinx: http://sphinx.pocoo.org/ |