Globally replace "hackage.haskell.org" with "ghc.haskell.org"
[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://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches "ghc.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         # can also say 'make -jX' for X number of jobs
66     $ make install
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 `perl 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`.
80
81 Once you have a build you need to keep it going.  You need to keep all
82 repos in sync with the [sync-all script] [7].  To get the latest changes:
83
84     $ ./sync-all pull
85     $ ./sync-all get
86
87 Filing bugs and feature requests
88 ================================
89
90 If you've encountered what you believe is a bug in GHC, or you'd like
91 to propose a feature request, please let us know! Submit a ticket in
92 our [bug tracker] [10] and we'll be sure to look into it. Remember:
93 **Filing a bug is the best way to make sure your issue isn't lost over
94 time**, so please feel free.
95
96 If you're an active user of GHC, you may also be interested in joining
97 the [glasgow-haskell-users] [11] mailing list, where developers and
98 GHC users discuss various topics and hang out.
99
100 Hacking & Developing GHC
101 ========================
102
103 Once you've filed a bug, maybe you'd like to fix it yourself? That
104 would be great, and we'd surely love your company! If you're looking
105 to hack on GHC, check out the guidelines in the `HACKING.md` file in
106 this directory - they'll get you up to speed quickly.
107
108 Contributors & Acknowledgements
109 ===============================
110
111 GHC in its current form wouldn't exist without the hard work of
112 [its many contributors] [12]. Over time, it has grown to include the
113 efforts and research of many institutions, highly talented people, and
114 groups from around the world. We'd like to thank them all, and invite
115 you to join!
116
117   [1]:  http://www.haskell.org/ghc/            "www.haskell.org/ghc/"
118   [2]:  http://ghc.haskell.org/trac/ghc    "ghc.haskell.org/trac/ghc"
119   [3]:  http://ghc.haskell.org/trac/ghc/wiki/Building
120           "ghc.haskell.org/trac/ghc/wiki/Building"
121   [4]:  http://www.haskell.org/happy/          "www.haskell.org/happy/"
122   [5]:  http://www.haskell.org/alex/           "www.haskell.org/alex/"
123   [6]:  http://www.haskell.org/haddock/        "www.haskell.org/haddock/"
124   [7]:  http://ghc.haskell.org/trac/ghc/wiki/Building/SyncAll
125           "http://ghc.haskell.org/trac/ghc/wiki/Building/SyncAll"
126   [8]:  http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
127           "http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation"
128   [9]:  http://www.haskell.org/cabal/          "http://www.haskell.org/cabal/"
129   [10]: http://ghc.haskell.org/trac/ghc/
130           "http://ghc.haskell.org/trac/ghc/"
131   [11]: http://www.haskell.org/pipermail/glasgow-haskell-users/
132           "http://www.haskell.org/pipermail/glasgow-haskell-users/"
133   [12]: http://ghc.haskell.org/trac/ghc/wiki/Contributors
134           "http://ghc.haskell.org/trac/ghc/wiki/Contributors"