Skip to content

Commit

Permalink
Update README for cmake build system
Browse files Browse the repository at this point in the history
  • Loading branch information
gjanssens committed Feb 9, 2021
1 parent cad4c52 commit a001c20
Showing 1 changed file with 54 additions and 10 deletions.
64 changes: 54 additions & 10 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,16 @@ see below under Other Formats.

Requirements
############
* autotools
* autotools (deprecated)
or
* cmake

* libxml2
* libxslt [Debian packed the required xsltproc in a separate package,
which depends on libxslt]
* 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)

Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand All @@ -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:
----------------------

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit a001c20

Please sign in to comment.