Add Note [No alternatives lint check]
[ghc.git] / INSTALL.md
1 Building & Installing
2 =====================
3
4 For full information on building GHC, see the GHC Building Guide [1].
5 Here follows a summary - if you get into trouble, the Building Guide
6 has all the answers.
7
8 Before building GHC you may need to install some other tools and
9 libraries.  See "Setting up your system for building GHC" [2].
10
11 NB. in particular you need GHC installed in order to build GHC,
12 because the compiler is itself written in Haskell.  For instructions
13 on how to port GHC to a new platform, see the Building Guide [1].
14
15 For building library documentation, you'll need Haddock [3].  To build
16 the compiler documentation, you need a good DocBook XML toolchain and
17 dblatex.
18
19 Quick start:  the following gives you a default build:
20
21     $ perl boot
22     $ ./configure
23     $ make
24     $ make install
25
26 The "perl boot" step is only necessary if this is a tree checked out
27 from git.  For source distributions downloaded from GHC's web site,
28 this step has already been performed.
29
30 These steps give you the default build, which includes everything
31 optimised and built in various ways (eg. profiling libs are built).
32 It can take a long time.  To customise the build, see the file
33 `HACKING.md`.
34
35 References
36 ==========
37
38  [1] http://www.haskell.org/ghc/
39  [2] http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation
40  [3] http://www.haskell.org/haddock/