aboutsummaryrefslogtreecommitdiff
path: root/doc/README
diff options
context:
space:
mode:
authorsimonmar <simonmar@microsoft.com>2005-10-29 08:14:43 +0000
committersimonmar <simonmar@microsoft.com>2005-10-29 08:14:43 +0000
commit766cecdda0a834e2a50a6aaa36518ea6b4ac360c (patch)
treec7f45cd024fa7ba65aa028421a6b7cedf17dbe7e /doc/README
parent21c7ac8d714be74903755ed2d6ee3716ab77a727 (diff)
Add configure script and Makefile for the docs
Add a separate configure script and build system for building the documentation. The configure and Makefile code is stolen from fptools. This is left as a separate build system so that the main Cabal setup doesn't require a Unix build environment or DocBook XML tools.
Diffstat (limited to 'doc/README')
-rw-r--r--doc/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/README b/doc/README
new file mode 100644
index 00000000..ab9c0f2f
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,25 @@
+Haddock documentation
+---------------------
+
+The documentation is in DocBook XML format. You need some tools to
+process it: at least xsltproc, and the DocBook XML DTD and XSL
+stylesheets. There's a configure script to detect the right way to
+process the documentation on your system, and a Makefile to actually
+do the processing (so, on Windows, you'll need Cygwin or MSys in
+addition to the DocBook XML tools). To build the HTML documentation:
+
+ $ ./configure
+ $ make html
+
+which leaves the HTML documentation in a haddock/ subdirectory.
+
+Printable documentation can also be produced, eg.:
+
+ $ make pdf
+
+or
+
+ $ make ps
+
+Generating the printed formats requires more tools (fop or xmltex) and
+tends to be a bit harder.