diff options
Diffstat (limited to 'doc/README')
-rw-r--r-- | doc/README | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/README b/doc/README new file mode 100644 index 0000000..5c0c268 --- /dev/null +++ b/doc/README @@ -0,0 +1,24 @@ +Building the documentation: + +You will need the following packages: + * xsltproc + * docbook + * docbook-xml + * docbook-xsl + * docbook-xsl-doc-html + * fop + +These are the debian/ubuntu package names; on other systems there are probably similar. + + +General Build: +> make + +Check the validity of the source +> make check + +Build just the html: +> make html + +Build just the pdf: +> make pdf |