MERGED: Give PrimOps a NOINLINE pragma, to suppress silly warnings from dsRule
[ghc.git] / README
diff --git a/README b/README
index d36c642..11a6ed3 100644 (file)
--- a/README
+++ b/README
@@ -27,35 +27,18 @@ There are two ways to get a source tree:
 
   which contains GHC itself and the "boot" libraries.
 
-  2. Check out the source code from darcs
-  ---------------------------------------
+  2. Check out the source code from git
+  -------------------------------------
 
-  The recommended way to get a darcs checkout is to start off by
-  downloading a snapshot with a name like:
+  First get the GHC git repository:
 
-      ghc-HEAD-2009-09-09-ghc-corelibs-testsuite.tar.bz2
+    $ git clone http://darcs.haskell.org/ghc.git/
 
-  from:
-
-      http://darcs.haskell.org/
-
-  and then untar it and bring it up-to-date with:
-
-     $ cd ghc
-     $ ./darcs-all get
-
-
-  Alternatively you can use darcs to get the repos, but it will take a
-  lot longer. First get the GHC darcs repository:
-
-    $ darcs get http://darcs.haskell.org/ghc/
-
-  Then run the darcs-all script in that repository
+  Then run the sync-all script in that repository
   to get the other repositories:
 
      $ cd ghc
-     $ chmod +x darcs-all
-     $ ./darcs-all get
+     $ ./sync-all get
 
   This checks out the "boot" packages.
 
@@ -67,12 +50,12 @@ For full information on building GHC, see the GHC Building Guide [3].
 Here follows a summary - if you get into trouble, the Building Guide
 has all the answers.
 
-NB. you need GHC installed in order to build GHC, because the compiler
-is itself written in Haskell.  For instructions on how to port GHC to a
-new platform, see the Building Guide.
+Before building GHC you may need to install some other tools and
+libraries.  See "Setting up your system for building GHC" [8].
 
-If you're building from darcs sources (as opposed to a source
-distribution) then you also need to install Happy [4] and Alex [5].
+NB. in particular you need GHC installed in order to build GHC,
+because the compiler is itself written in Haskell.  For instructions
+on how to port GHC to a new platform, see the Building Guide [3].
 
 For building library documentation, you'll need Haddock [6].  To build
 the compiler documentation, you need a good DocBook XML toolchain and
@@ -80,20 +63,24 @@ dblatex.
 
 Quick start:  the following gives you a default build:
 
-    $ sh boot
+    $ perl 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,
+The "perl boot" step is only necessary if this is a tree checked out
+from git.  For source distributions downloaded from GHC's web site,
 this step has already been performed.
 
 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
-HACKING.
+It can take a long time.  To customise the build, see the file HACKING.
+
+Once you have a build you need to keep it going.  You need to keep all
+repos in sync with the sync-all script [7].  To get the latest changes:
 
+    $ ./sync-all pull
+    $ ./sync-all get
 
 
 References
@@ -105,6 +92,8 @@ References
  [4] http://www.haskell.org/happy/                      Happy
  [5] http://www.haskell.org/alex/                       Alex
  [6] http://www.haskell.org/haddock/                    Haddock
+ [7] http://hackage.haskell.org/trac/ghc/wiki/Building/SyncAll
+ [8] http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation
 
 
 Contributors