manual: Add a README about editing the manual

diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am
index 837291f237b0bb806c2759df9f1d4995c82efcd0..ea885fb17c8fe00695813924716f00aaaa09ea81 100644 (file)
--- a/doc/manual/Makefile.am
+++ b/doc/manual/Makefile.am
@@ -77,6 +77,7 @@ EXTRA_DIST = \
        manual.xml \
        print.xsl \
        xhtml.xsl \
+       README \
        $(NULL)
 
 MANUAL_DOCBOOK_URL=https://wiki.gnome.org/Projects/Vala/Manual/Export?action=format\&mimetype=text/docbook

diff --git a/doc/manual/README b/doc/manual/README
new file mode 100644 (file)
index 0000000..aa680f1
--- /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 html'
+ * print - single page HTML with CSS page media, 'make print'
+ * pdf - uses WeasyPrint to generate from the print format, use 'make pdf'
+
+
+Status
+------
+The manual is a draft and contains a number of omissions and probably some
+errors.
+
+
+Contributing
+------------
+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.
+