diff options
| author | Ian Lynagh <igloo@earth.li> | 2008-01-06 21:57:23 +0000 |
|---|---|---|
| committer | Ian Lynagh <igloo@earth.li> | 2008-01-06 21:57:23 +0000 |
| commit | 5d9ab59646a5477cd1cd1b7149e0fb600d1361ed (patch) | |
| tree | 6623f1ed765051be3e491b94c85c9f7058a8c8f9 /README | |
| parent | 58d0b1faf2ea388c695fdaf55d80af9b87482572 (diff) | |
| download | haskell-5d9ab59646a5477cd1cd1b7149e0fb600d1361ed.tar.gz | |
Add instructions for building docs to README
Diffstat (limited to 'README')
| -rw-r--r-- | README | 18 |
1 files changed, 14 insertions, 4 deletions
@@ -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 |