Merge pull request #25 from angerman/patch-1
[hadrian.git] / README.md
1 Shaking up GHC
2 ==============
3
4 As part of my 6-month research secondment to Microsoft Research in Cambridge I am taking up the challenge of migrating the current [GHC](https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler) build system based on standard `make` into a new and (hopefully) better one based on [Shake](https://github.com/ndmitchell/shake/blob/master/README.md). If you are curious about the project you can find more details on the [wiki page](https://ghc.haskell.org/trac/ghc/wiki/Building/Shake) and in this [blog post](https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc/).
5
6 This is supposed to go into the `shake-build` directory of the GHC source tree.
7
8 Trying it
9 ---------
10
11 Prerequisits
12 ```
13 $ cabal install alex
14 $ cabal install shake
15 ```
16
17 On Linux,
18 ```
19 $ git clone git://git.haskell.org/ghc
20 $ cd ghc
21 $ git submodule update --init
22 $ git clone git://github.com/snowleopard/shaking-up-ghc shake-build
23 $ ./boot
24 $ ./configure
25 $ make inplace/bin/ghc-cabal   # This needs to be fixed
26 $ shake-build/build.sh
27 ```
28
29 On Windows,
30 ```
31 $ git clone --recursive git://git.haskell.org/ghc.git
32 $ cd ghc
33 $ git clone git://github.com/snowleopard/shaking-up-ghc shake-build
34 $ ./boot
35 $ ./configure --enable-tarballs-autodownload
36 $ make inplace/bin/ghc-cabal   # This needs to be fixed
37 $ shake-build/build.bat
38 ```
39 Also see the Building GHC on Windows guide: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows.
40
41 How to contribute
42 -----------------
43 The best way to contribute is to try the new build system, report the issues you found, and attempt to fix them. Please note the codebase is very unstable at present and we expect a lot of further refactoring. Before attempting to fix any issue do make sure no one else is already working on it. The documentation is currently non-existent, but we will start addressing this once the codebase stabilises.