configure.ac: drop unused VOID_INT_SIGNALS
[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   First clone the GHC github read-only repository:
30
31         $ git clone git://github.com/ghc/ghc.git
32
33   Then run the `sync-all` script in that repository to get the other repositories:
34
35         $ cd ghc
36         $ ./sync-all get
37
38   This checks out the "boot" packages.
39
40   **DO NOT submit pull request directly to the github repo.**
41   *See the GHC developer team's working conventions re [contributing patches](http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches "ghc.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches").*
42
43
44 Building & Installing
45 =====================
46
47 For full information on building GHC, see the [GHC Building Guide] [3].
48 Here follows a summary - if you get into trouble, the Building Guide
49 has all the answers.
50
51 Before building GHC you may need to install some other tools and
52 libraries.  See, [Setting up your system for building GHC] [8].
53
54 *NB.* In particular, you need [GHC] [1] installed in order to build GHC,
55 because the compiler is itself written in Haskell.  You also need
56 [Happy] [4], [Alex] [5], and [Cabal] [9].  For instructions on how
57 to port GHC to a new platform, see the [GHC Building Guide] [3].
58
59 For building library documentation, you'll need [Haddock] [6].  To build
60 the compiler documentation, you need a good DocBook XML toolchain and
61 dblatex.
62
63 **Quick start**: the following gives you a default build:
64
65     $ perl boot
66     $ ./configure
67     $ make         # can also say 'make -jX' for X number of jobs
68     $ make install
69
70 (NB: **Do you have multiple cores? Be sure to tell that to `make`!** This can
71 save you hours of build time depending on your system configuration, and is
72 almost always a win regardless of how many cores you have. As a simple rule,
73 you should have about N+1 jobs, where `N` is the amount of cores you have.)
74
75 The `perl boot` step is only necessary if this is a tree checked out
76 from git.  For source distributions downloaded from [GHC's web site] [1],
77 this step has already been performed.
78
79 These steps give you the default build, which includes everything
80 optimised and built in various ways (eg. profiling libs are built).
81 It can take a long time.  To customise the build, see the file `HACKING`.
82
83 Once you have a build you need to keep it going.  You need to keep all
84 repos in sync with the [sync-all script] [7].  To get the latest changes:
85
86     $ ./sync-all pull
87     $ ./sync-all get
88
89 Filing bugs and feature requests
90 ================================
91
92 If you've encountered what you believe is a bug in GHC, or you'd like
93 to propose a feature request, please let us know! Submit a ticket in
94 our [bug tracker] [10] and we'll be sure to look into it. Remember:
95 **Filing a bug is the best way to make sure your issue isn't lost over
96 time**, so please feel free.
97
98 If you're an active user of GHC, you may also be interested in joining
99 the [glasgow-haskell-users] [11] mailing list, where developers and
100 GHC users discuss various topics and hang out.
101
102 Hacking & Developing GHC
103 ========================
104
105 Once you've filed a bug, maybe you'd like to fix it yourself? That
106 would be great, and we'd surely love your company! If you're looking
107 to hack on GHC, check out the guidelines in the `HACKING.md` file in
108 this directory - they'll get you up to speed quickly.
109
110 Contributors & Acknowledgements
111 ===============================
112
113 GHC in its current form wouldn't exist without the hard work of
114 [its many contributors] [12]. Over time, it has grown to include the
115 efforts and research of many institutions, highly talented people, and
116 groups from around the world. We'd like to thank them all, and invite
117 you to join!
118
119   [1]:  http://www.haskell.org/ghc/            "www.haskell.org/ghc/"
120   [2]:  http://ghc.haskell.org/trac/ghc    "ghc.haskell.org/trac/ghc"
121   [3]:  http://ghc.haskell.org/trac/ghc/wiki/Building
122           "ghc.haskell.org/trac/ghc/wiki/Building"
123   [4]:  http://www.haskell.org/happy/          "www.haskell.org/happy/"
124   [5]:  http://www.haskell.org/alex/           "www.haskell.org/alex/"
125   [6]:  http://www.haskell.org/haddock/        "www.haskell.org/haddock/"
126   [7]:  http://ghc.haskell.org/trac/ghc/wiki/Building/SyncAll
127           "http://ghc.haskell.org/trac/ghc/wiki/Building/SyncAll"
128   [8]:  http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
129           "http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation"
130   [9]:  http://www.haskell.org/cabal/          "http://www.haskell.org/cabal/"
131   [10]: http://ghc.haskell.org/trac/ghc/
132           "http://ghc.haskell.org/trac/ghc/"
133   [11]: http://www.haskell.org/pipermail/glasgow-haskell-users/
134           "http://www.haskell.org/pipermail/glasgow-haskell-users/"
135   [12]: http://ghc.haskell.org/trac/ghc/wiki/Contributors
136           "http://ghc.haskell.org/trac/ghc/wiki/Contributors"