doc/manual/README

   1 Vala Reference Manual
   2 ---------------------
   3
   4 The reference manual can be generated in the following formats:
   5
   6  * devhelp - documentation browser for GNOME, use 'make all' or 'make devhelp'
   7  * html - multipage HTML, use 'make html'
   8  * print - single page HTML with CSS page media, 'make print'
   9  * pdf - uses WeasyPrint to generate from the print format, use 'make pdf'
  10
  11
  12 Status
  13 ------
  14 The manual is a draft and contains a number of omissions and probably some
  15 errors.
  16
  17
  18 Contributing
  19 ------------
  20 There are a number of ways you can contribute to improving the manual:
  21
  22  * Raise questions on the Vala communication channels so an edit is then made
  23  * Post blogs and other tutorials that can then be used as source material
  24    for updating the manual
  25  * Raise a report in bugzilla
  26  * Submit a patch to bugzilla with an amendment to the manual
  27
  28 Editing the manual
  29 ------------------
  30 The manual source is available at: https://wiki.gnome.org/Projects/Vala/Manual
  31 The wiki version is editable by anyone who has access.
  32
  33 To bring an edit in to the Vala source use 'make update-manual-from-wiki'
  34 This target will download the manual from the wiki. Using 'git diff' will show
  35 the changes. 'git add --patch' will allow changes to be added in stages.
  36