[vala/wip/manual: 21/21] manual: Add a README about editing the manual

commit dc19bc1af37878c29eba0c23056a96015ed90f5e
Author: Alistair Thomas <astavale yahoo co uk>
Date:   Sat Mar 11 23:15:31 2017 +0000

    manual: Add a README about editing the manual

 doc/manual/README |   36 ++++++++++++++++++++++++++++++++++++
 1 files changed, 36 insertions(+), 0 deletions(-)
diff --git a/doc/manual/README b/doc/manual/README
new file mode 100644
index 0000000..644941c
--- /dev/null
+++ b/doc/manual/README
@@ -0,0 +1,36 @@
+Vala Reference Manual
+The reference manual can be generated in the following formats:
+ * devhelp - documentation browser for GNOME, use 'make all' or 'make devhelp'
+ * html - multipage HTML, use 'make all' or 'make html'
+ * print - single page HTML with CSS page media, use 'make all' or 'make print'
+ * pdf - uses WeasyPrint to generate from the print format, use 'make pdf'
+The manual is a draft and contains a number of omissions and probably some
+There are a number of ways you can contribute to improving the manual:
+ * Raise questions on the Vala communication channels so an edit is then made
+ * Post blogs and other tutorials that can then be used as source material
+   for updating the manual
+ * Raise a report in bugzilla
+ * Submit a patch to bugzilla with an amendment to the manual
+Editing the manual
+The manual source is available at: https://wiki.gnome.org/Projects/Vala/Manual
+The wiki version is editable by anyone who has access.
+To bring an edit in to the Vala source use 'make update-manual-from-wiki'
+This target will download the manual from the wiki. Using 'git diff' will show
+the changes. 'git add --patch' will allow changes to be added in stages.

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]