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