Doc : added readme file whitch explain make functions and build dependencies
authorBenjamin Renard <brenard@aconit.easter-eggs.fr>
Fri, 13 Nov 2009 14:32:10 +0000 (15:32 +0100)
committerBenjamin Renard <brenard@aconit.easter-eggs.fr>
Fri, 13 Nov 2009 14:32:10 +0000 (15:32 +0100)
doc/README [new file with mode: 0644]

diff --git a/doc/README b/doc/README
new file mode 100644 (file)
index 0000000..660d8c8
--- /dev/null
@@ -0,0 +1,32 @@
+Makefile :
+##########
+
+The root Makefile permit currently 3 actions :
+ * Validation : For the xml validation of docbook files
+  make validate
+  
+ * Export : For build the documentation exports in all available formats
+  make export
+  
+ * Clean : Delete non-sources files
+  make clean
+
+Dependencies :
+##############
+
+For validation :
+================
+ * xmllint command (in debian package libxml2-utils)
+For exports :
+=============
+ * in HTML :
+ ~~~~~~~~~~~
+   + xsltproc command (in debian package xsltproc)
+   + XSL stylesheets by N.Walsh (html/docbook.xsl, htmlhelp/htmlhelp.xsl
+     and xhtml/chunk.xsl) (in debian package docbook-xsl)
+     
+ * in PDF :
+ ~~~~~~~~~~
+   + jw command (in debian package docbook-utils)