[project @ 1999-08-02 16:12:12 by simonmar]
[ghc-hetmet.git] / README
diff --git a/README b/README
index 590a8bb..4041e0d 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,36 @@
 This is the root directory for functional-programming tools
 distributed by the Computing Science Department at Glasgow University.
-Simon Peyton Jones <simonpj@dcs.glasgow.ac.uk> is the ringleader
-of this effort.  The tools are:
+Simon Peyton Jones <simonpj@microsoft.com> 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
+    hdirect     Haskell interop tool
+    green-card a foreign function interface pre-processor for Haskell.
     nofib      the NoFib Haskell benchmarking suite
     literate   the Glasgow "literate programming" system
-    mkworld    configuration system (derived from X11 imake)
     glafp-utils shared utility programs
+    mk         GNU make setup used by all of 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 "mkworld" (a configuration
-system).
+Components which are always part of a distribution (never stand-alone)
+are "glafp-utils" and "mk" (a configuration system).
+
+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.  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.