[project @ 1999-08-02 16:12:12 by simonmar]
[ghc-hetmet.git] / README
1 This is the root directory for functional-programming tools
2 distributed by the Computing Science Department at Glasgow University.
3 Simon Peyton Jones <simonpj@microsoft.com> is the ringleader of this
4 effort.  The tools are:
5
6     ghc         the Glasgow Haskell compilation system
7     hslibs      collection of Haskell libraries
8     haggis      the Haggis GUI toolkit
9     happy       the Happy Haskell parser generator
10     hdirect     Haskell interop tool
11     green-card  a foreign function interface pre-processor for Haskell.
12     nofib       the NoFib Haskell benchmarking suite
13     literate    the Glasgow "literate programming" system
14     glafp-utils shared utility programs
15     mk          GNU make setup used by all of fptools
16     docs        documentation on the installing and using
17                 the fptools suite.
18
19 Components which are always part of a distribution (never stand-alone)
20 are "glafp-utils" and "mk" (a configuration system).
21
22 Quick start:  the following is *supposed* to work
23
24         $ ./configure
25         $ make boot
26         $ make
27         $ make install
28
29 where 'make' is whatever GNU make is called on your system.  The
30 configuration script is a standard GNU autoconf script which accepts
31 all the normal arguments, eg. --prefix=<blah> to install the package
32 somewhere other than /usr/local.  Try ./configure --help to get a full
33 list of the options.
34
35 There is usually an ANNOUNCE* file with any distribution.  Please
36 consult that, or the <piece>/README file, to find out how to proceed.