README.md 5.3 KB
Newer Older
Ben Gamari's avatar
Ben Gamari committed
1 2
The Glasgow Haskell Compiler
============================
3

Ben Gamari's avatar
Ben Gamari committed
4
[![Build Status](https://api.travis-ci.org/ghc/ghc.svg?branch=master)](http://travis-ci.org/ghc/ghc)
5

Ben Gamari's avatar
Ben Gamari committed
6 7
This is the source tree for [GHC][1], a compiler and interactive
environment for the Haskell functional programming language.
8

Ben Gamari's avatar
Ben Gamari committed
9
For more information, visit [GHC's web site][1].
10

Ben Gamari's avatar
Ben Gamari committed
11
Information for developers of GHC can be found on the [GHC Trac][2].
12 13


Ben Gamari's avatar
Ben Gamari committed
14 15
Getting the Source
==================
16

Ben Gamari's avatar
Ben Gamari committed
17
There are two ways to get a source tree:
18

Ben Gamari's avatar
Ben Gamari committed
19
 1. *Download source tarballs*
20

Ben Gamari's avatar
Ben Gamari committed
21
  Download the GHC source distribution:
22

Ben Gamari's avatar
Ben Gamari committed
23
        ghc-<version>-src.tar.bz2
24

Ben Gamari's avatar
Ben Gamari committed
25
  which contains GHC itself and the "boot" libraries.
26

Ben Gamari's avatar
Ben Gamari committed
27
 2. *Check out the source code from git*
28

Ben Gamari's avatar
Ben Gamari committed
29
        $ git clone --recursive git://git.haskell.org/ghc.git
30

Ben Gamari's avatar
Ben Gamari committed
31 32
  Note: cloning GHC from Github requires a special setup. See [Getting a GHC
  repository from Github][7].
33

Ben Gamari's avatar
Ben Gamari committed
34
  *See the GHC team's working conventions regarding [how to contribute a patch to GHC](http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/FixingBugs).* First time contributors are encouraged to get started by just sending a Pull Request.
35

36

Ben Gamari's avatar
Ben Gamari committed
37 38
Building & Installing
=====================
39

Ben Gamari's avatar
Ben Gamari committed
40 41 42
For full information on building GHC, see the [GHC Building Guide][3].
Here follows a summary - if you get into trouble, the Building Guide
has all the answers.
43

Ben Gamari's avatar
Ben Gamari committed
44 45
Before building GHC you may need to install some other tools and
libraries.  See, [Setting up your system for building GHC][8].
46

Ben Gamari's avatar
Ben Gamari committed
47 48 49 50
*NB.* In particular, you need [GHC][1] installed in order to build GHC,
because the compiler is itself written in Haskell.  You also need
[Happy][4], [Alex][5], and [Cabal][9].  For instructions on how
to port GHC to a new platform, see the [GHC Building Guide][3].
51

Ben Gamari's avatar
Ben Gamari committed
52 53 54
For building library documentation, you'll need [Haddock][6].  To build
the compiler documentation, you need [Sphinx](http://www.sphinx-doc.org/)
and Xelatex (only for PDF output).
55

Ben Gamari's avatar
Ben Gamari committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
**Quick start**: the following gives you a default build:

    $ ./boot
    $ ./configure
    $ make         # can also say 'make -jX' for X number of jobs
    $ make install

  On Windows, you need an extra repository containing some build tools.
  These can be downloaded for you by configure. This only needs to be done once by running:

    $ ./configure --enable-tarballs-autodownload

(NB: **Do you have multiple cores? Be sure to tell that to `make`!** This can
save you hours of build time depending on your system configuration, and is
almost always a win regardless of how many cores you have. As a simple rule,
you should have about N+1 jobs, where `N` is the amount of cores you have.)

The `./boot` step is only necessary if this is a tree checked out
from git.  For source distributions downloaded from [GHC's web site][1],
this step has already been performed.

These steps give you the default build, which includes everything
optimised and built in various ways (eg. profiling libs are built).
It can take a long time.  To customise the build, see the file `HACKING.md`.

Filing bugs and feature requests
================================

If you've encountered what you believe is a bug in GHC, or you'd like
to propose a feature request, please let us know! Submit a ticket in
our [bug tracker][10] and we'll be sure to look into it. Remember:
**Filing a bug is the best way to make sure your issue isn't lost over
time**, so please feel free.

If you're an active user of GHC, you may also be interested in joining
the [glasgow-haskell-users][11] mailing list, where developers and
GHC users discuss various topics and hang out.

Hacking & Developing GHC
========================

Once you've filed a bug, maybe you'd like to fix it yourself? That
would be great, and we'd surely love your company! If you're looking
to hack on GHC, check out the guidelines in the `HACKING.md` file in
this directory - they'll get you up to speed quickly.

Contributors & Acknowledgements
===============================

GHC in its current form wouldn't exist without the hard work of
[its many contributors][12]. Over time, it has grown to include the
efforts and research of many institutions, highly talented people, and
groups from around the world. We'd like to thank them all, and invite
you to join!

  [1]:  http://www.haskell.org/ghc/            "www.haskell.org/ghc/"
  [2]:  http://ghc.haskell.org/trac/ghc    "ghc.haskell.org/trac/ghc"
  [3]:  http://ghc.haskell.org/trac/ghc/wiki/Building
          "ghc.haskell.org/trac/ghc/wiki/Building"
  [4]:  http://www.haskell.org/happy/          "www.haskell.org/happy/"
  [5]:  http://www.haskell.org/alex/           "www.haskell.org/alex/"
  [6]:  http://www.haskell.org/haddock/        "www.haskell.org/haddock/"
  [7]: https://ghc.haskell.org/trac/ghc/wiki/Building/GettingTheSources#GettingaGHCrepositoryfromGitHub
          "https://ghc.haskell.org/trac/ghc/wiki/Building/GettingTheSources#GettingaGHCrepositoryfromGitHub"
  [8]:  http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
          "http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation"
  [9]:  http://www.haskell.org/cabal/          "http://www.haskell.org/cabal/"
  [10]: http://ghc.haskell.org/trac/ghc/
          "http://ghc.haskell.org/trac/ghc/"
  [11]: http://www.haskell.org/pipermail/glasgow-haskell-users/
          "http://www.haskell.org/pipermail/glasgow-haskell-users/"
  [12]: http://ghc.haskell.org/trac/ghc/wiki/TeamGHC
          "http://ghc.haskell.org/trac/ghc/wiki/TeamGHC"