Add instructions for building docs to README
authorIan Lynagh <igloo@earth.li>
Sun, 6 Jan 2008 21:57:23 +0000 (21:57 +0000)
committerIan Lynagh <igloo@earth.li>
Sun, 6 Jan 2008 21:57:23 +0000 (21:57 +0000)
README

diff --git a/README b/README
index 68a012b..042137b 100644 (file)
--- a/README
+++ b/README
@@ -76,15 +76,25 @@ XML toolchain if you want to build the compiler documentation.
 
 Quick start:  the following gives you a default build:
 
-       $ sh boot
-       $ ./configure
-       $ make
-       $ make install
+    $ sh boot
+    $ ./configure
+    $ make
+    $ make install
 
 The "sh boot" step is only necessary if this is a tree checked out
 from darcs.  For source distributions downloaded from GHC's web site,
 this step has already been performed.
 
+If you want the documentation too then use these commands instead:
+
+    $ echo "XMLDocWays   = html" > mk/build.mk
+    $ echo "HADDOCK_DOCS = YES" >> mk/build.mk
+    $ sh boot
+    $ ./configure
+    $ make
+    $ make install
+    $ make install-docs
+
 These steps give you the default build, which includes everything
 optimised and built in various ways (eg. profiling libs are built).
 It can take a long time.  To customise the build, see the file