Make the treatment of equalities more uniform
[ghc-hetmet.git] / README
diff --git a/README b/README
index 3a87322..042137b 100644 (file)
--- a/README
+++ b/README
@@ -27,7 +27,7 @@ There are two ways to get a source tree:
       ghc-<version>-src-extralibs.tar.bz2
 
   You only need the first one, which contains GHC itself and
       ghc-<version>-src-extralibs.tar.bz2
 
   You only need the first one, which contains GHC itself and
-  the "core" libraries.
+  the "boot" libraries.
 
   The extralibs package contains a bunch of optional libraries.  If
   you want, you can unpack this over the top of your source tree, and
 
   The extralibs package contains a bunch of optional libraries.  If
   you want, you can unpack this over the top of your source tree, and
@@ -49,13 +49,13 @@ There are two ways to get a source tree:
   to get the other repositories:
 
      $ cd ghc
   to get the other repositories:
 
      $ cd ghc
-     $ chmod +x boot
-     $ ./boot
+     $ chmod +x darcs-all
+     $ ./darcs-all get
 
 
-  This grabs the "core" packages by default.  To get the full set of
+  This grabs the "boot" packages by default.  To get the full set of
   packages, instead say
 
   packages, instead say
 
-     $ ./boot --extra
+     $ ./darcs-all --extra get
 
   This also downloads the libraries that are normally bundled in the
   "extralibs" package (see above).
 
   This also downloads the libraries that are normally bundled in the
   "extralibs" package (see above).
@@ -76,9 +76,24 @@ XML toolchain if you want to build the compiler documentation.
 
 Quick start:  the following gives you a default build:
 
 
 Quick start:  the following gives you a default build:
 
-       $ ./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).
 
 These steps give you the default build, which includes everything
 optimised and built in various ways (eg. profiling libs are built).