FGCOM/jansson
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
* Python is no longer required to run the tests
* Mention pkg-config support
* Fix some errors
This commit is contained in:
Petri Lehtinen 2010-01-12 21:29:16 +02:00
parent 7f8684828d
commit b077d7988e
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.rst
View File

@ -36,8 +36,6 @@ To run the test suite, invoke::
$ make check $ make check
Python_ is required to run the tests.
Documentation Documentation
------------- -------------
@ -57,6 +55,5 @@ required to generate the documentation.
.. _Jansson: http://www.digip.org/jansson/ .. _Jansson: http://www.digip.org/jansson/
.. _`MIT license`: http://www.opensource.org/licenses/mit-license.php .. _`MIT license`: http://www.opensource.org/licenses/mit-license.php
.. _Python: http://www.python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/ .. _Sphinx: http://sphinx.pocoo.org/

19
doc/gettingstarted.rst
View File

@ -31,9 +31,9 @@ the ``--prefix=DIR`` argument to ``./configure``. See ``./configure
no options to customize the resulting Jansson binary.) no options to customize the resulting Jansson binary.)
The command ``make check`` runs the test suite distributed with The command ``make check`` runs the test suite distributed with
Jansson. Python_ is required to run the tests. This step is not Jansson. This step is not strictly necessary, but it may find possible
strictly necessary, but it may find possible problems that Jansson has problems that Jansson has on your platform. If any problems are found,
on your platform. If any problems are found, please report them. please report them.
If you obtained the source from a Git repository (or any other source If you obtained the source from a Git repository (or any other source
control system), there's no ``./configure`` script as it's not kept in control system), there's no ``./configure`` script as it's not kept in
@ -44,12 +44,11 @@ to use ``autoreconf``::
autoreconf -vi autoreconf -vi
This command creates the ``./configure`` script, which can then be This command creates the ``./configure`` script, which can then be
used as described in the previous section. used as described above.
.. _autoconf: http://www.gnu.org/software/autoconf/ .. _autoconf: http://www.gnu.org/software/autoconf/
.. _automake: http://www.gnu.org/software/automake/ .. _automake: http://www.gnu.org/software/automake/
.. _libtool: http://www.gnu.org/software/libtool/ .. _libtool: http://www.gnu.org/software/libtool/
.. _Python: http://www.python.org/
Installing Prebuilt Binary Packages Installing Prebuilt Binary Packages
@ -85,8 +84,8 @@ required to generate the documentation.
.. _Sphinx: http://sphinx.pocoo.org/ .. _Sphinx: http://sphinx.pocoo.org/
Compiling Programs Using Jansson Compiling Programs That Use Jansson
================================ ===================================
Jansson involves one C header file, :file:`jansson.h`, so it's enough Jansson involves one C header file, :file:`jansson.h`, so it's enough
to put the line to put the line
@ -101,3 +100,9 @@ There's also just one library to link with, ``libjansson``. Compile and
link the program as follows:: link the program as follows::
cc -o prog prog.c -ljansson cc -o prog prog.c -ljansson
Starting from version 1.2, there's also support for pkg-config_::
cc -o prog prog.c `pkg-config --cflags --libs jansson`
.. _pkg-config: http://pkg-config.freedesktop.org/