Revert "Make sure README.md mentions that make can build in parallel."
[ghc.git] / README.md
1 The Glasgow Haskell Compiler
2 ============================
3
4 This is the source tree for [GHC] [1], a compiler and interactive
5 environment for the Haskell functional programming language.
6
7 For more information, visit [GHC's web site] [1].
8
9 Information for developers of GHC can be found on the [GHC Trac] [2].
10
11
12 Getting the Source
13 ==================
14
15 There are two ways to get a source tree:
16
17  1. *Download source tarballs*
18
19   Download the GHC source distribution:
20
21         ghc-<version>-src.tar.bz2
22
23   which contains GHC itself and the "boot" libraries.
24
25  2. *Check out the source code from git*
26
27   First clone the GHC github read-only repository:
28
29         $ git clone git://github.com/ghc/ghc.git
30
31   Then run the `sync-all` script in that repository to get the other repositories:
32
33         $ cd ghc
34         $ ./sync-all get
35
36   This checks out the "boot" packages.
37
38   **DO NOT submit pull request directly to the github repo.**
39   *See the GHC developer team's working conventions re [contributing patches](http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches "hackage.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches").*
40
41
42 Building & Installing
43 =====================
44
45 For full information on building GHC, see the [GHC Building Guide] [3].
46 Here follows a summary - if you get into trouble, the Building Guide
47 has all the answers.
48
49 Before building GHC you may need to install some other tools and
50 libraries.  See, [Setting up your system for building GHC] [8].
51
52 *NB.* In particular, you need [GHC] [1] installed in order to build GHC,
53 because the compiler is itself written in Haskell.  You also need
54 [Happy] [4], [Alex] [5], and [Cabal] [9].  For instructions on how
55 to port GHC to a new platform, see the [GHC Building Guide] [3].
56
57 For building library documentation, you'll need [Haddock] [6].  To build
58 the compiler documentation, you need a good DocBook XML toolchain and
59 dblatex.
60
61 **Quick start**: the following gives you a default build:
62
63     $ perl boot
64     $ ./configure
65     $ make
66     $ make install
67
68 The `perl boot` step is only necessary if this is a tree checked out
69 from git.  For source distributions downloaded from [GHC's web site] [1],
70 this step has already been performed.
71
72 These steps give you the default build, which includes everything
73 optimised and built in various ways (eg. profiling libs are built).
74 It can take a long time.  To customise the build, see the file `HACKING`.
75
76 Once you have a build you need to keep it going.  You need to keep all
77 repos in sync with the [sync-all script] [7].  To get the latest changes:
78
79     $ ./sync-all pull
80     $ ./sync-all get
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://hackage.haskell.org/trac/ghc    "hackage.haskell.org/trac/ghc"
114   [3]:  http://hackage.haskell.org/trac/ghc/wiki/Building
115           "hackage.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]:  http://hackage.haskell.org/trac/ghc/wiki/Building/SyncAll
120           "http://hackage.haskell.org/trac/ghc/wiki/Building/SyncAll"
121   [8]:  http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation
122           "http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation"
123   [9]:  http://www.haskell.org/cabal/          "http://www.haskell.org/cabal/"
124   [10]: http://hackage.haskell.org/trac/ghc/
125           "http://hackage.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://hackage.haskell.org/trac/ghc/wiki/Contributors
129           "http://hackage.haskell.org/trac/ghc/wiki/Contributors"