[Checkins] SVN: grok/trunk/doc/reference/README.txt - added small README to inform people how to build the manual

[Christian Theune]

Log message for revision 70869:
   - added small README to inform people how to build the manual
  

Changed:
  A   grok/trunk/doc/reference/README.txt

-=-
Added: grok/trunk/doc/reference/README.txt
===================================================================
--- grok/trunk/doc/reference/README.txt	2006-10-21 15:43:09 UTC (rev 70868)
+++ grok/trunk/doc/reference/README.txt	2006-10-21 15:49:15 UTC (rev 70869)
@@ -0,0 +1,24 @@
+=========================
+The grok reference manual
+=========================
+
+The manual is written using LaTeX with support for the Python documentation
+markup. The tex sources can be compiled to HTML and PDF. To build the manual,
+you need the 'mkhowto' script from a recent Python source distribution.
+
+Build the HTML
+--------------
+
+  $ mkhowto --html reference.tex
+
+The directory 'reference/' keeps all files required to display the manual after
+that call and can be put on a static webserver.
+
+Build the PDF
+-------------
+
+The file 'reference.pdf' will contain the PDF version of the manual after this
+call:
+
+  $ mkhowto --html reference.tex
+


Property changes on: grok/trunk/doc/reference/README.txt
___________________________________________________________________
Name: svn:keywords
   + Id Rev Date
Name: svn:eol-style
   + native