gnucash-docs master: Update README
Frank H.Ellenberger
fell at code.gnucash.org
Sat Mar 17 11:30:04 EDT 2018
Updated via https://github.com/Gnucash/gnucash-docs/commit/6c7cad27 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/ba7ca7a8 (commit)
commit 6c7cad2726d169a8d860e2a10723cd81a85eeb78
Author: fell <frank.h.ellenberger at gmail.com>
Date: Sat Mar 17 16:29:59 2018 +0100
Update README
diff --git a/README b/README
index fa5019b..96c73be 100644
--- a/README
+++ b/README
@@ -2,13 +2,23 @@
GnuCash Docs README file
------------------------------------------------------------
-This is the docs module for GnuCash. The docs can be accessed
-from Yelp (the Gnome help browser) directly without any conversion.
-If you wish to obtain a copy of the documentation in another format,
-like html, pdf or others, see below under Other Formats.
+This is the user documentation (docs) module for GnuCash. Written in DocBook
+ they can be accessed under
+* directly without any conversion:
+** Linux: from Yelp (the Gnome help browser)
+
+* after conversion:
+** MacOs: html
+** Windows: chm
+** mobile devices: mobi, epub
+** paper: pdf
+
+If you wish to obtain a copy of the documentation in one of the latter formats,
+see below under Other Formats.
Requirements
############
+* autotools
* libxml2
* libxslt [Debian packed the required xsltproc in a separate package,
@@ -21,6 +31,15 @@ Requirements
Optional:
* gnome-doc-utils (contains xml2po for the use of po editors like in the it translation)
+Additional Requirements for Generating Mobipocket:
+
+* Calibre (https://www.calibre-ebook.com/)
+
+Additional Requirements for Generating chm:
+
+* Mingw (http://www.mingw.org)
+* Html Help Workshop (https://www.microsoft.com/en-us/download/details.aspx?id=21138 for Win XP - 8)
+
Additonal Requirements for Generating PDF:
* Apache fop >= 0.95
@@ -31,16 +50,12 @@ other Japanese fonts you can use the with-japanese-fonts-dir,
options to select them. fop's TTFReader can't, as of version 1.1
anyway, handle OpenType fonts.
-Additional Requirements for Generating Mobipocket:
-
-* Calibre (http://www.calibre-ebook.com/)
-
Notes
#####
The GnuCash docs team is actively seeking contributors. Even if you
only have time for reviewing, editing or translating the existing docs this
-can help. PLEASE let us know via the gnucash-devel mailing list what
+can help. PLEASE let us know via IRC or the gnucash-devel mailing list what
you can work on or help with.
See also:
@@ -176,11 +191,17 @@ hints or suggestions with the docs. There are a few known problems.
- Guide needs some updates still.
-That's it for now! Please report any problems to the Gnome bugzilla at
+- Full list:
+https://bugzilla.gnome.org/buglist.cgi?product=GnuCash&component=Documentation
+
+That's it for now! Please report any new problems to the Gnome bugzilla at
https://bugzilla.gnome.org/browse.cgi?product=GnuCash. Then choose the
component Documentation.
-Feel free to append your updates also there.
+Feel free to append your updates also there or open a pull request.
+Only docs about future features should go in branch master.
+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:
@@ -193,6 +214,7 @@ With any problems you have, you can contact us in the following ways:
** es: https://lists.gnucash.org/mailman/listinfo/gnucash-es
** fr: https://lists.gnucash.org/mailman/listinfo/gnucash-fr
** it: https://lists.gnucash.org/mailman/listinfo/gnucash-it
+** nl: https://lists.gnucash.org/mailman/listinfo/gnucash-nl
** pt: https://lists.gnucash.org/mailman/listinfo/gnucash-br
: or your recent translator
Summary of changes:
README | 44 +++++++++++++++++++++++++++++++++-----------
1 file changed, 33 insertions(+), 11 deletions(-)
More information about the gnucash-changes
mailing list