~stub/ubuntu/trusty/avro-c/trunk

« back to all changes in this revision

Viewing changes to jansson/README.rst

  • Committer: Stuart Bishop
  • Date: 2015-05-14 11:53:53 UTC
  • Revision ID: stuart@stuartbishop.net-20150514115353-0cvnrcyohcq5l7yj
Tags: upstream-1.7.7
ImportĀ upstreamĀ versionĀ 1.7.7

Show diffs side-by-side

added added

removed removed

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