gnucash-docs maint: Put cmake info before the deprecated autotools info

Geert Janssens gjanssens at code.gnucash.org
Wed Feb 10 07:03:49 EST 2021


Updated	 via  https://github.com/Gnucash/gnucash-docs/commit/7bc23844 (commit)
	from  https://github.com/Gnucash/gnucash-docs/commit/a001c20e (commit)



commit 7bc2384479e236e40bcec0eb2f7553450f699981
Author: Geert Janssens <geert at kobaltwit.be>
Date:   Wed Feb 10 13:03:41 2021 +0100

    Put cmake info before the deprecated autotools info

diff --git a/README b/README
index f379d4a..ce8a2fd 100644
--- a/README
+++ b/README
@@ -96,25 +96,24 @@ the figures/ directory directly beneath the HTML directory:
 --------------------------
 
 You can generate the documentation in html, pdf, epub and mobi
-using the autotools based build system that comes with the sources.
+using the build system that comes with the sources.
 
-For the deprecated autotools system the commands are:
+For cmake the commands are
   cd gnucash-docs
-  ./autogen.sh
   mkdir build && cd build
   # If you don't need mobi
-  ../configure
+  cmake ..
   # or, if you need mobi
-  ../configure --with-mobi
+  cmake -D WITH_MOBY ..
 
-For cmake the commands are
+For the deprecated autotools system the commands are:
   cd gnucash-docs
+  ./autogen.sh
   mkdir build && cd build
   # If you don't need mobi
-  cmake ..
+  ../configure
   # or, if you need mobi
-  cmake -D WITH_MOBY ..
-
+  ../configure --with-mobi
 
 => This will tell you if you are missing some required tools.
 
@@ -138,6 +137,29 @@ To generate the documentation in mobi format, instead run
 If you only wish to generate a subset of the documentation, you can. However
 the way to do so depends on the build system:
 
+- CMake
+There are specific targets for each document. The target is of the form
+<language>-gnucash-<doc>-<type>.
+
+For example to only generate the English concepts guide:
+
+  make C-gnucash-guide-html
+  make C-gnucash-guide-pdf
+  make C-gnucash-guide-epub
+  make C-gnucash-guide-mobi
+
+depending on the output format you require.
+
+In addition one could generate these formats for one document in all
+languages at once by omitting the language specifier in the target.
+
+For example:
+
+  make gnucash-help-html
+
+will generate the html version of the help document in all supported
+languages.
+
 - Autotools (deprecated)
 Go into the directory for that subset and run the above make commands
 from there. For example to only generate the English concepts guide:
@@ -162,29 +184,6 @@ or
 
 depending on the output format you require.
 
-- CMake
-There are specific targets for each document. The target is of the form
-<language>-gnucash-<doc>-<type>.
-
-For example to only generate the English concepts guide:
-
-  make C-gnucash-guide-html
-  make C-gnucash-guide-pdf
-  make C-gnucash-guide-epub
-  make C-gnucash-guide-mobi
-
-depending on the output format you require.
-
-In addition one could generate these formats for one document in all
-languages at once by omitting the language specifier in the target.
-
-For example:
-
-  make gnucash-help-html
-
-will generate the html version of the help document in all supported
-languages.
-
 * running xmllint
 -----------------
 You can also run xmllint on all documents or a specific document with the command



Summary of changes:
 README | 63 +++++++++++++++++++++++++++++++--------------------------------
 1 file changed, 31 insertions(+), 32 deletions(-)



More information about the gnucash-changes mailing list