gnucash-docs maint: Update README for cmake build system

[Geert Janssens]

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



commit a001c20eafbac6b3efc0af1c9a0f92c0c8cc39f0
Author: Geert Janssens <geert at kobaltwit.be>
Date:   Tue Feb 9 14:00:08 2021 +0100

    Update README for cmake build system

diff --git a/README b/README
index 2e34554..f379d4a 100644
--- a/README
+++ b/README
@@ -18,7 +18,9 @@ see below under Other Formats.
 
 Requirements
 ############
-* autotools
+* autotools (deprecated)
+or
+* cmake
 
 * libxml2
 * libxslt [Debian packed the required xsltproc in a separate package, 
@@ -26,10 +28,6 @@ Requirements
 * docbook-xsl
 * yelp (for viewing)
 
-Only Gnome <=2 based desktops:
-* rarian or
-  scrollkeeper >=0.3.4 (its ancestor)
-
 Optional:
 * gnome-doc-utils (contains xml2po for the use of po editors like in the italian translation)
 
@@ -100,12 +98,23 @@ 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.
 
+For the deprecated autotools system the commands are:
   cd gnucash-docs
   ./autogen.sh
+  mkdir build && cd build
+  # If you don't need mobi
+  ../configure
+  # or, if you need mobi
+  ../configure --with-mobi
+
+For cmake the commands are
+  cd gnucash-docs
+  mkdir build && cd build
   # If you don't need mobi
-  ./configure
+  cmake ..
   # or, if you need mobi
-  ./configure --with-mobi
+  cmake -D WITH_MOBY ..
+
 
 => This will tell you if you are missing some required tools.
 
@@ -126,8 +135,11 @@ To generate the documentation in mobi format, instead run
   make mobi
   (Note: mobi is generated from epub, so this generates epub files as well.)
 
-If you only wish to generate a subset of the documentation, you can
-go into the directory for that subset and run the above make commands
+If you only wish to generate a subset of the documentation, you can. However
+the way to do so depends on the build system:
+
+- 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:
 
   cd guide/C
@@ -150,6 +162,38 @@ 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
+
+  make check # for toplevel check or (autotools only) per document check in
+             # the respective subdirectories
+  make de-gnucash-help-check # for a cmake check for one specific document
+                             # in this example - the German help guide
+
 * XML/XSL-based tools:
 ----------------------
 
@@ -203,7 +247,7 @@ So here is the link for branch stable:
 https://github.com/Gnucash/gnucash-docs/pull/new/maint.
 
 - With any problems you have, you can contact us in the following ways:
- 
+
 * quick questions via IRC
 ** en: irc://irc.gnome.org/gnucash 
 : see http://wiki.gnucash.org/wiki/IRC



Summary of changes:
 README | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 54 insertions(+), 10 deletions(-)