X-Git-Url: http://git.kpe.io/?p=clsql.git;a=blobdiff_plain;f=doc%2FREADME;fp=doc%2FREADME;h=5c0c26885afb53d5e0e36a861eabae8238f86620;hp=0000000000000000000000000000000000000000;hb=406feeb749bb475bec8077a2716a5b6089bd9072;hpb=e41e6a54e54a32bbb3e7d359c21175465b05cd6c

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