Add a new section "Getting the Source" to both HACKING and README. But what about...
[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 First get the GHC darcs repository:
20
21    $ darcs get http://darcs.haskell.org/ghc/
22
23 Then run the darcs-all shell script in that repository 
24 to get the other repositories:
25
26    $ cd ghc
27    $ sh darcs-all
28
29
30 Building & Installing
31 =====================
32
33 NB. you need GHC installed in order to build GHC, because the compiler
34 is itself written in Haskell.  It is possible to build GHC using just
35 a C compiler, but we don't recommend this as the normal route.  If you
36 *really* want to do it this way, then see the Building Guide (link
37 below).
38
39 You also need a few other tools installed: Happy [4], Alex [5], and
40 Haddock [6] (for building library documentation), and a good DocBook
41 XML toolchain if you want to build the compiler documentation. 
42
43 Quick start:  the following gives you a default build:
44
45         $ autoreconf
46         $ ./configure
47         $ make
48         $ make install
49
50 The autoreconf step is only necessary if this is a tree checked out
51 from darcs.  For source distributions downloaded from GHC's web site,
52 this step has already been performed.
53
54 These steps give you the default build, which includes everything
55 optimised and built in various ways (eg. profiling libs are built).
56 It can take a long time.  To customise the build, see the file
57 HACKING.
58
59 For full information on building GHC, see the GHC Building Guide [3],
60 which is also available in source form (DocBook XML) in docs/building.
61
62
63 References
64 ==========
65
66  [1] http://www.haskell.org/ghc/                GHC Home Page
67  [2] http://hackage.haskell.org/trac/ghc        GHC Developer's Wiki
68  [3] http://www.haskell.org/ghc/docs/latest/html/building/index.html
69                                                 Building Guide
70
71  [4] http://www.haskell.org/happy/              Happy
72  [5] http://www.haskell.org/alex/               Alex
73  [6] http://www.haskell.org/haddock/            Haddock
74
75
76 Contributors
77 ============
78
79 Please see
80   
81    http://www.haskell.org/ghc/contributors.html