summaryrefslogtreecommitdiffstats
path: root/office/gnucash-docs/README
diff options
context:
space:
mode:
Diffstat (limited to 'office/gnucash-docs/README')
-rw-r--r--office/gnucash-docs/README17
1 files changed, 10 insertions, 7 deletions
diff --git a/office/gnucash-docs/README b/office/gnucash-docs/README
index 0dbc6ce019..87d6c20c04 100644
--- a/office/gnucash-docs/README
+++ b/office/gnucash-docs/README
@@ -5,12 +5,17 @@ This builds the internal help and user guides for Gnucash.
For the HTML help and user guides to read outside of the Gnucash
application, pass HTML="yes" to the script.
-For the EPUB help and user guides, pass EPUB="yes" to the script.
+For the epub help and user guides, pass EPUB="yes" to the script.
+
+For the mobi (Amazon Kindle) help and user guides, make sure
+ calibre-bin is installed, and pass MOBI="yes" to the script.
+ (Note: mobi is generated from epub, so this generates epub files
+ as well.)
For the PDF help and user guides, make sure fop is installed and
configured, and pass PDF="yes" to the script.
-After installation, HTML, EPUB, and PDF documentation can be found
+After installation, HTML, EPUB, MOBI and PDF documentation can be found
in /usr/doc/gnucash-$VERSION.
For a specific language, pass DOCLANG="xx", where xx is:
@@ -19,12 +24,10 @@ de for German
it for Italian
pt for Portugese
ja for Japanese (guide only, no help - defaults to C)
-ru for Russian (guide only, no help - defaults to C)
+NOTE: the Russian translation has been dropped
-Note 1: This script builds the internal guides in all available
+Note: This script builds the internal guides in all available
languages, but the HTML guides are only in the spacified language
to save space and avoid excessive package bloat.
-Note 2: This builds the docs for version 3.x of Gnucash. If you
-need the old stable 2.6 branch, use gnucash-legacy-docs, also
-available on SBo.
+Runtime dependencies are yelp and rarian.