[project @ 2005-03-10 14:03:28 by simonmar]
[ghc-hetmet.git] / README
diff --git a/README b/README
index 5aab572..0adcfdd 100644 (file)
--- a/README
+++ b/README
@@ -8,10 +8,12 @@ the following directories:
 
     ghc                  The Glasgow Haskell Compiler
     hslibs       A Collection of Haskell libraries
+    haddock      A Haskell documentation tool
     haggis       The Haggis GUI toolkit
     happy        The Happy Haskell parser generator
     hdirect       Haskell interop tool
-    green-card   A foreign function interface pre-processor for Haskell.
+    greencard    A foreign function interface pre-processor for Haskell.
+    libraries    Haskell libraries (reqd. by ghc)
     nofib        The NoFib Haskell benchmarking suite
 
 Additional documentation for each project can be found in its
@@ -28,21 +30,29 @@ In addition, the following directories contain project-independent bits:
 Quick start:  the following is *supposed* to work
 
        $ ./configure
-       $ make boot
        $ make
        $ make install
 
 where 'make' is whatever GNU make is called on your system (GNU make
-is *required*).  The configuration script is a standard GNU autoconf
-script which accepts all the normal arguments, eg. --prefix=<blah> to
-install the package somewhere other than /usr/local.  Try ./configure
---help to get a full list of the options.
+is *required*).  If there are any other tools required for the build,
+then the configure script will detect them and tell you if any are
+missing.  For example, a working GHC installation is required for
+building most of the tools (including GHC itself).
+
+The configuration script is a standard GNU autoconf script which
+accepts all the normal arguments, eg. --prefix=<blah> to install the
+package somewhere other than /usr/local.  Try ./configure --help to
+get a full list of the options.
 
 There is usually an ANNOUNCE* file with any distribution.  Please
 consult that, or the <piece>/README file, to find out how to proceed.
 
-Full documentation for the fptools build system can be found on the
-GHC web pages: 
+Full documentation for the fptools build system can be found in the 
+Building Guide:
+
+       http://www.haskell.org/ghc/docs/latest/html/building/building-guide.html
+
+More information about GHC can be found here:
 
        http://www.haskell.org/ghc/