Fix recompilation detection when set of signatures to merge changes.
[ghc.git] / README.md
1 The Glasgow Haskell Compiler
2 ============================
3
4 [![Build Status](https://api.travis-ci.org/ghc/ghc.svg?branch=master)](http://travis-ci.org/ghc/ghc)
5
6 This is the source tree for [GHC][1], a compiler and interactive
7 environment for the Haskell functional programming language.
8
9 For more information, visit [GHC's web site][1].
10
11 Information for developers of GHC can be found on the [GHC Trac][2].
12
13
14 Getting the Source
15 ==================
16
17 There are two ways to get a source tree:
18
19  1. *Download source tarballs*
20
21   Download the GHC source distribution:
22
23         ghc-<version>-src.tar.bz2
24
25   which contains GHC itself and the "boot" libraries.
26
27  2. *Check out the source code from git*
28
29         $ git clone --recursive git://git.haskell.org/ghc.git
30
31   Note: cloning GHC from Github requires a special setup. See [Getting a GHC
32   repository from Github] [7].
33
34   **DO NOT submit pull request directly to the github repo.**
35   *See the GHC team's working conventions re [how to contribute a patch to GHC](http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/FixingBugs).*
36
37
38 Building & Installing
39 =====================
40
41 For full information on building GHC, see the [GHC Building Guide] [3].
42 Here follows a summary - if you get into trouble, the Building Guide
43 has all the answers.
44
45 Before building GHC you may need to install some other tools and
46 libraries.  See, [Setting up your system for building GHC] [8].
47
48 *NB.* In particular, you need [GHC] [1] installed in order to build GHC,
49 because the compiler is itself written in Haskell.  You also need
50 [Happy] [4], [Alex] [5], and [Cabal] [9].  For instructions on how
51 to port GHC to a new platform, see the [GHC Building Guide] [3].
52
53 For building library documentation, you'll need [Haddock] [6].  To build
54 the compiler documentation, you need [Sphinx](http://www.sphinx-doc.org/)
55 and Xelatex (only for PDF output).
56
57 **Quick start**: the following gives you a default build:
58
59     $ ./boot
60     $ ./configure
61     $ make         # can also say 'make -jX' for X number of jobs
62     $ make install
63
64   On Windows, you need an extra repository containing some build tools.
65   These can be downloaded for you by configure. This only needs to be done once by running:
66
67     $ ./configure --enable-tarballs-autodownload
68
69 (NB: **Do you have multiple cores? Be sure to tell that to `make`!** This can
70 save you hours of build time depending on your system configuration, and is
71 almost always a win regardless of how many cores you have. As a simple rule,
72 you should have about N+1 jobs, where `N` is the amount of cores you have.)
73
74 The `./boot` step is only necessary if this is a tree checked out
75 from git.  For source distributions downloaded from [GHC's web site] [1],
76 this step has already been performed.
77
78 These steps give you the default build, which includes everything
79 optimised and built in various ways (eg. profiling libs are built).
80 It can take a long time.  To customise the build, see the file `HACKING`.
81
82 Filing bugs and feature requests
83 ================================
84
85 If you've encountered what you believe is a bug in GHC, or you'd like
86 to propose a feature request, please let us know! Submit a ticket in
87 our [bug tracker] [10] and we'll be sure to look into it. Remember:
88 **Filing a bug is the best way to make sure your issue isn't lost over
89 time**, so please feel free.
90
91 If you're an active user of GHC, you may also be interested in joining
92 the [glasgow-haskell-users] [11] mailing list, where developers and
93 GHC users discuss various topics and hang out.
94
95 Hacking & Developing GHC
96 ========================
97
98 Once you've filed a bug, maybe you'd like to fix it yourself? That
99 would be great, and we'd surely love your company! If you're looking
100 to hack on GHC, check out the guidelines in the `HACKING.md` file in
101 this directory - they'll get you up to speed quickly.
102
103 Contributors & Acknowledgements
104 ===============================
105
106 GHC in its current form wouldn't exist without the hard work of
107 [its many contributors] [12]. Over time, it has grown to include the
108 efforts and research of many institutions, highly talented people, and
109 groups from around the world. We'd like to thank them all, and invite
110 you to join!
111
112   [1]:  http://www.haskell.org/ghc/            "www.haskell.org/ghc/"
113   [2]:  http://ghc.haskell.org/trac/ghc    "ghc.haskell.org/trac/ghc"
114   [3]:  http://ghc.haskell.org/trac/ghc/wiki/Building
115           "ghc.haskell.org/trac/ghc/wiki/Building"
116   [4]:  http://www.haskell.org/happy/          "www.haskell.org/happy/"
117   [5]:  http://www.haskell.org/alex/           "www.haskell.org/alex/"
118   [6]:  http://www.haskell.org/haddock/        "www.haskell.org/haddock/"
119   [7]: https://ghc.haskell.org/trac/ghc/wiki/Building/GettingTheSources#GettingaGHCrepositoryfromGitHub
120           "https://ghc.haskell.org/trac/ghc/wiki/Building/GettingTheSources#GettingaGHCrepositoryfromGitHub"
121   [8]:  http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
122           "http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation"
123   [9]:  http://www.haskell.org/cabal/          "http://www.haskell.org/cabal/"
124   [10]: http://ghc.haskell.org/trac/ghc/
125           "http://ghc.haskell.org/trac/ghc/"
126   [11]: http://www.haskell.org/pipermail/glasgow-haskell-users/
127           "http://www.haskell.org/pipermail/glasgow-haskell-users/"
128   [12]: http://ghc.haskell.org/trac/ghc/wiki/TeamGHC
129           "http://ghc.haskell.org/trac/ghc/wiki/TeamGHC"