1 The Glasgow Haskell Compiler
2 ============================
4 This is the source tree for GHC, a compiler and interactive
5 environment for the Haskell functional programming language.
7 For more information, visit GHC's web site:
9 http://www.haskell.org/ghc/
11 Information for developers of GHC can be found here:
13 http://hackage.haskell.org/trac/ghc/
19 There are two ways to get a source tree:
21 1. Download source tarballs
22 ---------------------------
24 Download the GHC source distribution:
26 ghc-<version>-src.tar.bz2
28 which contains GHC itself and the "boot" libraries.
30 2. Check out the source code from git
31 -------------------------------------
33 First get the GHC git repository:
35 $ git clone http://darcs.haskell.org/ghc.git/
37 Then run the sync-all script in that repository
38 to get the other repositories:
43 This checks out the "boot" packages.
49 For full information on building GHC, see the GHC Building Guide [3].
50 Here follows a summary - if you get into trouble, the Building Guide
53 Before building GHC you may need to install some other tools and
54 libraries. See "Setting up your system for building GHC" [8].
56 NB. in particular you need GHC installed in order to build GHC,
57 because the compiler is itself written in Haskell. For instructions
58 on how to port GHC to a new platform, see the Building Guide [3].
60 For building library documentation, you'll need Haddock [6]. To build
61 the compiler documentation, you need a good DocBook XML toolchain and
64 Quick start: the following gives you a default build:
71 The "perl boot" step is only necessary if this is a tree checked out
72 from git. For source distributions downloaded from GHC's web site,
73 this step has already been performed.
75 These steps give you the default build, which includes everything
76 optimised and built in various ways (eg. profiling libs are built).
77 It can take a long time. To customise the build, see the file HACKING.
79 Once you have a build you need to keep it going. You need to keep all
80 repos in sync with the sync-all script [7]. To get the latest changes:
89 [1] http://www.haskell.org/ghc/ GHC Home Page
90 [2] http://hackage.haskell.org/trac/ghc GHC Developer's Wiki
91 [3] http://hackage.haskell.org/trac/ghc/wiki/Building Building Guide
92 [4] http://www.haskell.org/happy/ Happy
93 [5] http://www.haskell.org/alex/ Alex
94 [6] http://www.haskell.org/haddock/ Haddock
95 [7] http://hackage.haskell.org/trac/ghc/wiki/Building/SyncAll
96 [8] http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation
104 http://www.haskell.org/ghc/contributors.html