More useful error message when a package .hi file cannot be found:
[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 "boot" 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 script in that repository
49   to get the other repositories:
50
51      $ cd ghc
52      $ chmod +x darcs-all
53      $ ./darcs-all get
54
55   This grabs the "boot" packages by default.  To get the full set of
56   packages, instead say
57
58      $ ./darcs-all --extra get
59
60   This also downloads the libraries that are normally bundled in the
61   "extralibs" package (see above).
62
63
64 Building & Installing
65 =====================
66
67 For full information on building GHC, see the GHC Building Guide [3].
68 Here follows a summary - if you get into trouble, the Building Guide
69 has all the answers.
70
71 NB. you need GHC installed in order to build GHC, because the compiler
72 is itself written in Haskell.  It is possible to build GHC using just
73 a C compiler, but we don't recommend this as the normal route.  If you
74 *really* want to do it this way, then see the Building Guide.
75
76 If you're building from darcs sources (as opposed to a source
77 distribution) then you also need to install Happy [4] and Alex [5].
78
79 For building library documentation, you'll need Haddock [6].  To build
80 the compiler documentation, you need a good DocBook XML toolchain.
81
82 Quick start:  the following gives you a default build:
83
84     $ sh boot
85     $ ./configure
86     $ make
87     $ make install
88
89 The "sh boot" step is only necessary if this is a tree checked out
90 from darcs.  For source distributions downloaded from GHC's web site,
91 this step has already been performed.
92
93 If you want the documentation too then use these commands instead:
94
95     $ echo "XMLDocWays   = html" > mk/build.mk
96     $ echo "HADDOCK_DOCS = YES" >> mk/build.mk
97     $ sh boot
98     $ ./configure
99     $ make
100     $ make install
101     $ make install-docs
102
103 These steps give you the default build, which includes everything
104 optimised and built in various ways (eg. profiling libs are built).
105 It can take a long time.  To customise the build, see the file
106 HACKING.
107
108
109
110 References
111 ==========
112
113  [1] http://www.haskell.org/ghc/                        GHC Home Page
114  [2] http://hackage.haskell.org/trac/ghc                GHC Developer's Wiki
115  [3] http://hackage.haskell.org/trac/ghc/wiki/Building  Building Guide
116  [4] http://www.haskell.org/happy/                      Happy
117  [5] http://www.haskell.org/alex/                       Alex
118  [6] http://www.haskell.org/haddock/                    Haddock
119
120
121 Contributors
122 ============
123
124 Please see
125
126    http://www.haskell.org/ghc/contributors.html