Add spec file

[jansson.git] / doc / gettingstarted.rst

diff --git a/doc/gettingstarted.rst b/doc/gettingstarted.rst
index 34d2ab9..eb5f683 100644 (file)
--- a/doc/gettingstarted.rst
+++ b/doc/gettingstarted.rst
@@ -10,6 +10,9 @@ Compiling and Installing Jansson
 The Jansson source is available at
 http://www.digip.org/jansson/releases/.
 
+Unix-like systems
+-----------------
+
 Unpack the source tarball and change to the source directory:
 
 .. parsed-literal::
@@ -37,7 +40,7 @@ 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
-version control. To create the script, Autotools needs to be
+version control. To create the script, the build system needs to be
 bootstrapped. There are many ways to do this, but the easiest one is
 to use ``autoreconf``::
 
@@ -51,18 +54,30 @@ used as described above.
 .. _libtool: http://www.gnu.org/software/libtool/
 
 
-Installing Prebuilt Binary Packages
------------------------------------
+Other Systems
+-------------
+
+On Windows and other non Unix-like systems, you may be unable to run
+the ``./configure`` script. In this case, follow these steps. All the
+files mentioned can be found in the ``src/`` directory.
+
+1. Create ``jansson_config.h``. This file has some platform-specific
+   parameters that are normally filled in by the ``./configure``
+   script:
+
+   - On Windows, rename ``jansson_config.h.win32`` to ``jansson_config.h``.
 
-Binary ``.deb`` packages for Ubuntu are available in `this PPA`_ at
-Launchpad_. Follow the instructions in the PPA ("Technical details
-about this PPA" link) to take the PPA into use. Then install the -dev
-package::
+   - On other systems, edit ``jansson_config.h.in``, replacing all
+     ``@variable@`` placeholders, and rename the file to
+     ``jansson_config.h``.
 
-  sudo apt-get install libjansson-dev
+2. Make ``jansson.h`` and ``jansson_config.h`` available to the
+   compiler, so that they can be found when compiling programs that
+   use Jansson.
 
-.. _this PPA: http://launchpad.net/~petri/+archive/ppa
-.. _Launchpad: http://launchpad.net/
+3. Compile all the ``.c`` files (in the ``src/`` directory) into a
+   library file. Make the library available to the compiler, as in
+   step 2.
 
 
 Building the Documentation
@@ -77,14 +92,14 @@ documentation, invoke::
 
    make html
 
-and point your browser to ``doc/_build/html/index.html``. Sphinx_ is
-required to generate the documentation.
+and point your browser to ``doc/_build/html/index.html``. Sphinx_ 1.0
+or newer is required to generate the documentation.
 
 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
 .. _Sphinx: http://sphinx.pocoo.org/
 
 
-Compiling Programs That Use Jansson
+Compiling Programs that Use Jansson
 ===================================
 
 Jansson involves one C header file, :file:`jansson.h`, so it's enough