summaryrefslogtreecommitdiff
path: root/README
blob: b1b408a7aa6556233a1ddc7229eadee3bdf7f85b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
GHC build system
================

This is the top-level directory of the fptools build system.  Several
packages are part of this build system; if you got this as part of a
source distribution (eg. for GHC), then you will have one or more of
the following directories:

    ghc		  The Glasgow Haskell Compiler
    hslibs	  A Collection of Haskell libraries
    haddock	  A Haskell documentation tool
    haggis	  The Haggis GUI toolkit
    happy	  The Happy Haskell parser generator
    hdirect       Haskell interop tool
    greencard	  A foreign function interface pre-processor for Haskell.
    libraries	  Haskell libraries (reqd. by ghc)
    nofib	  The NoFib Haskell benchmarking suite

Additional documentation for each project can be found in its
respective directory.

In addition, the following directories contain project-independent bits:

    mk	          GNU make setup used by all of fptools
    glafp-utils   Shared utility programs
    docs          Documentation on the installing and using
                  the fptools build system.
    distrib	  Tools and additional bits for building distributions

Quick start:  the following is *supposed* to work

	$ ./configure
	$ make
	$ make install

where 'make' is whatever GNU make is called on your system (GNU make
is *required*).  If there are any other tools required for the build,
then the configure script will detect them and tell you if any are
missing.  For example, a working GHC installation is required for
building most of the tools (including GHC itself).

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.

Full documentation for the fptools build system can be found in the 
Building Guide:

	http://www.haskell.org/ghc/docs/latest/html/building/building-guide.html

More information about GHC can be found here:

	http://www.haskell.org/ghc/

--
The GHC Team,  glasgow-haskell-users@haskell.org