view docs/README @ 322:69adaab94ffd

Add notes about coding style and submission guidelines. As became clear from recent conversation, matching submitted code to the format of the existing code is not an obvious thing to do. (It should be but apparently it just doesn't occur to people.) Some description of the coding style is now present in the README. Additionally, submission guidelines have also been added to make it clear that patches (diffs) are the preferred means of providing code changes.
author William Astle <lost@l-w.ca>
date Mon, 03 Mar 2014 21:54:12 -0700
parents 2c24602be78f
children
line wrap: on
line source

If there are no html files in the "manual" directory and there is no
"manual.html" file, it means that you have either checked out the source
repository on a non-release branch or the packager messed up.

In either case, if you have "docbook2html" installed, you should be able
to build the manual with one of the following:

docbook2html -o manual manual.docbook.sgml

or

docbook2html -u manual.docbook.sgml && mv manual.docbook.html manual/manual.html

PDF can be generated by doing:

docbook2pdf -u manual.docbook.sgml && mv manual.docbook.pdf manual/manual.pdf