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