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