From 77b9de12c1311de56ffe3aaf6ea2b4f3b3d30a90 Mon Sep 17 00:00:00 2001
From: Benjamin Renard <brenard@aconit.easter-eggs.fr>
Date: Fri, 13 Nov 2009 15:32:10 +0100
Subject: [PATCH] Doc : added readme file whitch explain make functions and
 build dependencies

---
 doc/README | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 doc/README

diff --git a/doc/README b/doc/README
new file mode 100644
index 00000000..660d8c89
--- /dev/null
+++ b/doc/README
@@ -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)
+