diff options
| -rw-r--r-- | README.rst | 3 | ||||
| -rw-r--r-- | doc/gettingstarted.rst | 19 |
2 files changed, 12 insertions, 10 deletions
@@ -36,8 +36,6 @@ To run the test suite, invoke:: $ make check -Python_ is required to run the tests. - Documentation ------------- @@ -57,6 +55,5 @@ 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/ diff --git a/doc/gettingstarted.rst b/doc/gettingstarted.rst index 2221d07..34d2ab9 100644 --- a/doc/gettingstarted.rst +++ b/doc/gettingstarted.rst @@ -31,9 +31,9 @@ the ``--prefix=DIR`` argument to ``./configure``. See ``./configure no options to customize the resulting Jansson binary.) The command ``make check`` runs the test suite distributed with -Jansson. Python_ is required to run the tests. This step is not -strictly necessary, but it may find possible problems that Jansson has -on your platform. If any problems are found, please report them. +Jansson. This step is not strictly necessary, but it may find possible +problems that Jansson has on your platform. If any problems are found, +please report them. 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 @@ -44,12 +44,11 @@ to use ``autoreconf``:: autoreconf -vi 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/ .. _automake: http://www.gnu.org/software/automake/ .. _libtool: http://www.gnu.org/software/libtool/ -.. _Python: http://www.python.org/ Installing Prebuilt Binary Packages @@ -85,8 +84,8 @@ required to generate the documentation. .. _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 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:: 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/ |