[project @ 2000-07-13 14:45:13 by simonmar]
[ghc.git] / README
1 fptools build system
2 ====================
3
4 This is the top-level directory of the fptools build system.  Several
5 packages are part of this build system; if you got this as part of a
6 source distribution (eg. for GHC), then you will have one or more of
7 the following directories:
8
9     ghc           The Glasgow Haskell Compiler
10     hslibs        A Collection of Haskell libraries
11     haggis        The Haggis GUI toolkit
12     happy         The Happy Haskell parser generator
13     hdirect       Haskell interop tool
14     green-card    A foreign function interface pre-processor for Haskell.
15     nofib         The NoFib Haskell benchmarking suite
16
17 Additional documentation for each project can be found in its
18 respective directory.
19
20 In addition, the following directories contain project-independent bits:
21
22     mk            GNU make setup used by all of fptools
23     glafp-utils   Shared utility programs
24     docs          Documentation on the installing and using
25                   the fptools build system.
26     distrib       Tools and additional bits for building distributions
27
28 Quick start:  the following is *supposed* to work
29
30         $ ./configure
31         $ make boot
32         $ make
33         $ make install
34
35 where 'make' is whatever GNU make is called on your system (GNU make
36 is *required*).  The configuration script is a standard GNU autoconf
37 script which accepts all the normal arguments, eg. --prefix=<blah> to
38 install the package somewhere other than /usr/local.  Try ./configure
39 --help to get a full list of the options.
40
41 There is usually an ANNOUNCE* file with any distribution.  Please
42 consult that, or the <piece>/README file, to find out how to proceed.
43
44 Full documentation for the fptools build system can be found on the
45 GHC web pages: 
46
47         http://www.haskell.org/ghc/
48
49 --
50 The GHC Team,  glasgow-haskell-users@haskell.org