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 NB. you need GHC installed in order to build GHC, because the compiler
  68 is itself written in Haskell.  It is possible to build GHC using just
  69 a C compiler, but we don't recommend this as the normal route.  If you
  70 *really* want to do it this way, then see the Building Guide (link
  71 below).
  72
  73 You also need a few other tools installed: Happy [4], Alex [5], and
  74 Haddock [6] (for building library documentation), and a good DocBook
  75 XML toolchain if you want to build the compiler documentation.
  76
  77 Quick start:  the following gives you a default build:
  78
  79     $ sh boot
  80     $ ./configure
  81     $ make
  82     $ make install
  83
  84 The "sh boot" step is only necessary if this is a tree checked out
  85 from darcs.  For source distributions downloaded from GHC's web site,
  86 this step has already been performed.
  87
  88 If you want the documentation too then use these commands instead:
  89
  90     $ echo "XMLDocWays   = html" > mk/build.mk
  91     $ echo "HADDOCK_DOCS = YES" >> mk/build.mk
  92     $ sh boot
  93     $ ./configure
  94     $ make
  95     $ make install
  96     $ make install-docs
  97
  98 These steps give you the default build, which includes everything
  99 optimised and built in various ways (eg. profiling libs are built).
 100 It can take a long time.  To customise the build, see the file
 101 HACKING.
 102
 103 For full information on building GHC, see the GHC Building Guide [3].
 104
 105
 106 References
 107 ==========
 108
 109  [1] http://www.haskell.org/ghc/                        GHC Home Page
 110  [2] http://hackage.haskell.org/trac/ghc                GHC Developer's Wiki
 111  [3] http://hackage.haskell.org/trac/ghc/wiki/Building  Building Guide
 112  [4] http://www.haskell.org/happy/                      Happy
 113  [5] http://www.haskell.org/alex/                       Alex
 114  [6] http://www.haskell.org/haddock/                    Haddock
 115
 116
 117 Contributors
 118 ============
 119
 120 Please see
 121
 122    http://www.haskell.org/ghc/contributors.html