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 N.B. 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 [Sphinx](http://www.sphinx-doc.org/) and
  17 XeLaTex (only for PDF output).
  18
  19 Quick start:  the following gives you a default build:
  20
  21     $ ./boot
  22     $ ./configure
  23     $ ./hadrian/build
  24
  25   On Windows, you need an extra repository containing some build tools.
  26   These can be downloaded for you by configure. This only needs to be done once by running:
  27
  28     $ ./configure --enable-tarballs-autodownload
  29
  30 You can use `-jN` option to parallelize the build. It's generally best
  31 to set `N` somewhere around the core count of the build machine.
  32
  33 The `./boot` step is only necessary if this is a tree checked out from
  34 git. For source distributions downloaded from GHC's web site, this step has
  35 already been performed.
  36
  37 These steps give you the default build, which includes everything
  38 optimised and built in various ways (eg. profiling libs are built).
  39 It can take a long time.  To customise the build, see the file
  40 `HACKING.md`.
  41
  42 References
  43 ==========
  44
  45  - [1] http://www.haskell.org/ghc/
  46  - [2] https://gitlab.haskell.org/ghc/ghc/wikis/building/preparation
  47  - [3] http://www.haskell.org/haddock/