README 2.16 KB
Newer Older
1
2
The Glasgow Haskell Compiler
============================
3

4
5
This is the source tree for GHC, a compiler and interactive
environment for the Haskell functional programming language.
6

7
For more information, visit GHC's web site:
8

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

11
Information for developers of GHC can be found here:
12

13
  http://hackage.haskell.org/trac/ghc/
14

15

16
17
18
19
20
21
22
23
24
25
26
27
28
29
Getting the Source
==================

First get the GHC darcs repository:

   $ darcs get http://darcs.haskell.org/ghc/

Then run the darcs-all shell script in that repository 
to get the other repositories:

   $ cd ghc
   $ sh darcs-all


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
46
47
48
49
	$ ./configure
	$ make
	$ make install

50
51
52
53
54
55
56
57
58
59
60
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.
61

62

63
64
References
==========
65

66
67
68
69
 [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
70

71
72
73
 [4] http://www.haskell.org/happy/		Happy
 [5] http://www.haskell.org/alex/		Alex
 [6] http://www.haskell.org/haddock/		Haddock
74

75

76
77
Contributors
============
78

79
80
81
Please see
  
   http://www.haskell.org/ghc/contributors.html