X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=README;h=c2967fcfda17086182f8ae778aafee89538bb0b3;hp=7054beae68bca3529d86dfe748087f940cd3c287;hb=82a36a85dc7150d7b7172e221741bf39eaa8eaab;hpb=a54d9c5e3bcc6613f06ee9bebbc46b255c12f2ca

diff --git a/README b/README
index 7054bea..c2967fc 100644
--- a/README
+++ b/README
@@ -1,23 +1,67 @@
-This is the root directory for functional-programming tools
-distributed by the Computing Science Department at Glasgow University.
-Simon Peyton Jones <simonpj@dcs.gla.ac.uk> is the ringleader of this
-effort.  The tools are:
-
-    ghc		the Glasgow Haskell compilation system
-    hslibs	collection of Haskell libraries
-    haggis	the Haggis GUI toolkit
-    happy	the Happy Haskell parser generator
-    nofib	the NoFib Haskell benchmarking suite
-    literate	the Glasgow "literate programming" system
-    glafp-utils shared utility programs
-    mk	        GNU make setup used by all the fptools
-    docs        documentation on the installing and using
-                the fptools suite.
-
-The "literate" stuff is usually distributed *with* other systems, but
-not necessarily.  Components which are always part of a distribution
-(never stand-alone) are "glafp-utils" and "mk" (a configuration
-system).
-
-There is usually an ANNOUNCE* file with any distribution.  Please
-consult that, or the <piece>/README file, to find out how to proceed.
+The Glasgow Haskell Compiler
+============================
+
+This is the source tree for GHC, a compiler and interactive
+environment for the Haskell functional programming language.
+
+For more information, visit GHC's web site:
+
+  http://www.haskell.org/ghc/
+
+Information for developers of GHC can be found here:
+
+  http://hackage.haskell.org/trac/ghc/
+
+
+Building & Installing
+=====================
+
+NB. you need GHC installed in order to build GHC, because the compiler
+is itself written in Haskell.  It is possible to build GHC using just
+a C compiler, but we don't recommend this as the normal route.  If you
+*really* want to do it this way, then see the Building Guide (link
+below).
+
+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. 
+
+Quick start:  the following gives you a default build:
+
+	$ autoreconf
+	$ ./configure
+	$ make
+	$ make install
+
+The autoreconf 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.
+
+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.
+
+For full information on building GHC, see the GHC Building Guide [3],
+which is also available in source form (DocBook XML) in docs/building.
+
+
+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
+
+
+Contributors
+============
+
+Please see
+  
+   http://www.haskell.org/ghc/contributors.html