Skip to content

Commit

Permalink
Put cmake info before the deprecated autotools info
Browse files Browse the repository at this point in the history
  • Loading branch information
gjanssens committed Feb 10, 2021
1 parent a001c20 commit 7bc2384
Showing 1 changed file with 31 additions and 32 deletions.
63 changes: 31 additions & 32 deletions README
Expand Up @@ -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.

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

0 comments on commit 7bc2384

Please sign in to comment.