summaryrefslogtreecommitdiff
path: root/office/gnucash-docs/README
diff options
context:
space:
mode:
Diffstat (limited to 'office/gnucash-docs/README')
-rw-r--r--office/gnucash-docs/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/office/gnucash-docs/README b/office/gnucash-docs/README
new file mode 100644
index 0000000000..7a76977da4
--- /dev/null
+++ b/office/gnucash-docs/README
@@ -0,0 +1,18 @@
+This is the documentation package for Gnucash.
+
+This builds the internal help and user guides for Gnucash.
+
+For the HTML help and user guides to read outside the Gnucash
+application, pass HTML="yes" to the script.
+
+For a specific language, pass DOCLANG="xx", where xx is:
+C for English (default)
+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: 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 any excessive package bloat.