remove old building guide, change links to point to the wiki
[ghc.git] / README
1 The Glasgow Haskell Compiler
2 ============================
3
4 This is the source tree for GHC, a compiler and interactive
5 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 Getting the Source
17 ==================
18
19 There are two ways to get a source tree:
20
21   1. Download source tarballs
22   ---------------------------
23
24   The GHC source distribution comes in two parts:
25
26       ghc-<version>-src.tar.bz2
27       ghc-<version>-src-extralibs.tar.bz2
28
29   You only need the first one, which contains GHC itself and
30   the "core" libraries.  
31
32   The extralibs package contains a bunch of optional libraries.  If
33   you want, you can unpack this over the top of your source tree, and
34   these extra libraries will be built and installed automatically.
35   Make sure you unpack the extralibs package before running configure
36   (see below).
37
38   If you don't build extralibs now, you can add them later by building
39   and installing individual packages using Cabal.
40
41   2. Get the source from darcs
42   ----------------------------
43
44   First get the GHC darcs repository:
45
46     $ darcs get http://darcs.haskell.org/ghc/
47
48   Then run the darcs-all shell script in that repository 
49   to get the other repositories:
50
51      $ cd ghc
52      $ sh darcs-all get
53
54   This grabs the "core" packages by default.  To get the full set of
55   packages, instead say
56
57      $ sh darcs-all --extra get
58
59   This also downloads the libraries that are normally bundled in the
60   "extralibs" package (see above).
61
62
63 Building & Installing
64 =====================
65
66 NB. you need GHC installed in order to build GHC, because the compiler
67 is itself written in Haskell.  It is possible to build GHC using just
68 a C compiler, but we don't recommend this as the normal route.  If you
69 *really* want to do it this way, then see the Building Guide (link
70 below).
71
72 You also need a few other tools installed: Happy [4], Alex [5], and
73 Haddock [6] (for building library documentation), and a good DocBook
74 XML toolchain if you want to build the compiler documentation. 
75
76 Quick start:  the following gives you a default build:
77
78         $ autoreconf
79         $ ./configure
80         $ make
81         $ make install
82
83 The autoreconf step is only necessary if this is a tree checked out
84 from darcs.  For source distributions downloaded from GHC's web site,
85 this step has already been performed.
86
87 These steps give you the default build, which includes everything
88 optimised and built in various ways (eg. profiling libs are built).
89 It can take a long time.  To customise the build, see the file
90 HACKING.
91
92 For full information on building GHC, see the GHC Building Guide [3],
93 which is also available in source form (DocBook XML) in docs/building.
94
95
96 References
97 ==========
98
99  [1] http://www.haskell.org/ghc/                GHC Home Page
100  [2] http://hackage.haskell.org/trac/ghc        GHC Developer's Wiki
101  [3] http://hackage.haskell.org/trac/ghc/wiki/Building
102                                                 Building Guide
103
104  [4] http://www.haskell.org/happy/              Happy
105  [5] http://www.haskell.org/alex/               Alex
106  [6] http://www.haskell.org/haddock/            Haddock
107
108
109 Contributors
110 ============
111
112 Please see
113   
114    http://www.haskell.org/ghc/contributors.html