[geany/geany] cf631f: README: Extend build instructions

Colomban Wendling git-noreply at xxxxx
Sun Jun 26 11:50:57 UTC 2016


Branch:      refs/heads/master
Author:      Colomban Wendling <ban at herbesfolles.org>
Committer:   Colomban Wendling <ban at herbesfolles.org>
Date:        Sun, 26 Jun 2016 11:50:57 UTC
Commit:      cf631fb2571f8bb6b889070019f3cf91007a8999
             https://github.com/geany/geany/commit/cf631fb2571f8bb6b889070019f3cf91007a8999

Log Message:
-----------
README: Extend build instructions


Modified Paths:
--------------
    README

Modified: README
42 lines changed, 30 insertions(+), 12 deletions(-)
===================================================================
@@ -40,18 +40,36 @@ GNU versions of these tools are recommended.
 
 Installation
 ------------
-Installing Geany is done by the following three commands:
-$ ./configure
-$ make
-(as root)
-% make install
-
-If you are building from a Git clone rather than a source tarball, you need
-to run ./autogen.sh first, after having installed GLib's development files.
-You will also need rst2html from Docutils to build the documentation.
-
-For more configuration details run
-$ ./configure --help
+
+To build the user manual you need *rst2html* from Docutils. A pre-built
+version of the manual is available in distribution tarballs and will be used as
+fallback if *rst2html* is missing. When building from Git however, that
+pre-built version is not included and *rst2html* is required by default.
+You can explicitly disable building the user manual using the
+``--disable-html-docs`` *configure* flag, but this will result in not
+installing a local version of the user manual, and Geany will then try
+and open the online version instead when requested.
+
+Installing from a Git clone
++++++++++++++++++++++++++++
+
+Install Autotools (*automake*, *autoconf* and *libtool*), *intltool*,
+and the GLib development files **before** running any of the following
+commands, as well as *rst2html* from Docutils (see above for details).
+Then, run ``./autogen.sh`` and then follow the instructions for
+`installing from a release tarball`_.
+
+Installing from a release tarball
++++++++++++++++++++++++++++++++++
+
+Run the the following three commands::
+
+    $ ./configure
+    $ make
+    (as root, or using sudo)
+    % make install
+
+For more configuration details run ``./configure --help``
 
 If there are any errors during compilation, check your build environment
 and try to find the error, otherwise contact the mailing list or one of



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).


More information about the Commits mailing list