allow build settings to be overriden by adding mk/validate.mk

[ghc-hetmet.git] / README

diff --git a/README b/README
index c2967fc..25122a8 100644 (file)
--- a/README
+++ b/README
@@ -13,6 +13,54 @@ Information for developers of GHC can be found here:
   http://hackage.haskell.org/trac/ghc/
 
 
   http://hackage.haskell.org/trac/ghc/
 
 

+Getting the Source
+==================
+
+There are two ways to get a source tree:
+
+  1. Download source tarballs
+  ---------------------------
+
+  The GHC source distribution comes in two parts:
+
+      ghc-<version>-src.tar.bz2
+      ghc-<version>-src-extralibs.tar.bz2
+
+  You only need the first one, which contains GHC itself and
+  the "core" 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
+  these extra libraries will be built and installed automatically.
+  Make sure you unpack the extralibs package before running configure
+  (see below).
+
+  If you don't build extralibs now, you can add them later by building
+  and installing individual packages using Cabal.
+
+  2. Get the source from darcs
+  ----------------------------
+
+  First get the GHC darcs repository:
+
+    $ darcs get http://darcs.haskell.org/ghc/
+
+  Then run the darcs-all script in that repository
+  to get the other repositories:
+
+     $ cd ghc
+     $ chmod +x darcs-all
+     $ ./darcs-all get
+
+  This grabs the "core" packages by default.  To get the full set of
+  packages, instead say
+
+     $ ./darcs-all --extra get
+
+  This also downloads the libraries that are normally bundled in the
+  "extralibs" package (see above).
+
+

 Building & Installing
 =====================
 
 Building & Installing
 =====================
 

@@ -24,16 +72,16 @@ below).
 
 You also need a few other tools installed: Happy [4], Alex [5], and
 Haddock [6] (for building library documentation), and a good DocBook
 
 You also need a few other tools installed: Happy [4], Alex [5], and
 Haddock [6] (for building library documentation), and a good DocBook

-XML toolchain if you want to build the compiler documentation. 
+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:
 

-       $ autoreconf
+       $ sh boot

        $ ./configure
        $ make
        $ make install
 
        $ ./configure
        $ make
        $ make install
 

-The autoreconf step is only necessary if this is a tree checked out
+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.
 
 from darcs.  For source distributions downloaded from GHC's web site,
 this step has already been performed.
 

@@ -42,26 +90,23 @@ optimised and built in various ways (eg. profiling libs are built).
 It can take a long time.  To customise the build, see the file
 HACKING.
 
 It can take a long time.  To customise the build, see the file
 HACKING.
 

-For full information on building GHC, see the GHC Building Guide [3],
-which is also available in source form (DocBook XML) in docs/building.
+For full information on building GHC, see the GHC Building Guide [3].

 
 
 References
 ==========
 
 
 
 References
 ==========
 

- [1] http://www.haskell.org/ghc/               GHC Home Page
- [2] http://hackage.haskell.org/trac/ghc       GHC Developer's Wiki
- [3] http://www.haskell.org/ghc/docs/latest/html/building/index.html
-                                               Building Guide
-
- [4] http://www.haskell.org/happy/             Happy
- [5] http://www.haskell.org/alex/              Alex
- [6] http://www.haskell.org/haddock/           Haddock
+ [1] http://www.haskell.org/ghc/                        GHC Home Page
+ [2] http://hackage.haskell.org/trac/ghc                GHC Developer's Wiki
+ [3] http://hackage.haskell.org/trac/ghc/wiki/Building  Building Guide
+ [4] http://www.haskell.org/happy/                      Happy
+ [5] http://www.haskell.org/alex/                       Alex
+ [6] http://www.haskell.org/haddock/                    Haddock

 
 
 Contributors
 ============
 
 Please see
 
 
 Contributors
 ============
 
 Please see

-  
+

    http://www.haskell.org/ghc/contributors.html
    http://www.haskell.org/ghc/contributors.html