move the "meat" into the wiki, this file just contains pointers now
[ghc.git] / HACKING
1 Getting started with hacking on GHC
2 -----------------------------------
3
4 So you've decided to hack on GHC, congratulations!  We hope you have a
5 rewarding experience.  This file will point you in the direction of
6 information to help you get started right away.
7
8
9 The GHC Developer's Wiki
10 ------------------------
11
12   The home for GHC Developers, with information on accessing the
13   latest sources, the bug tracker, and documentation on the
14   code:
15   
16   http://hackage.haskell.org/trac/ghc
17   
18   In particular, the wiki contains the following pages of interest to
19   new hackers:
20   
21   Quick Start for developers
22
23      http://hackage.haskell.org/trac/ghc/wiki/Building/Hacking 
24    
25      This section on the wiki will get you up & running with a 
26      serviceable build tree in no time:
27   
28      This is part of the "Building GHC" section of the wiki, which
29      has more detailed information on GHC's build system should you
30      need it.
31   
32   
33   The GHC Commentary
34   
35      http://hackage.haskell.org/trac/wiki/Commentary
36
37      Notes on the internals and architecture of GHC.
38      
39
40 Mailing lists
41 -------------
42
43    Ask on glasgow-haskell-users@haskell.org if you have difficulties.
44    If you're working with the current CVS sources of GHC, then
45    cvs-ghc@haskell.org might be a more appropriate (developers hang
46    out here).  See http://www.haskell.org/mailman/listinfo for
47    subscription.
48
49
50 Happy Hacking!  --The GHC Team