Updates travis and README to reflect fixing #26
[hadrian.git] / README.md
1 Shaking up GHC
2 ==============
3
4 [![Build Status](https://travis-ci.org/snowleopard/shaking-up-ghc.svg)](https://travis-ci.org/snowleopard/shaking-up-ghc)
5
6 As part of my 6-month research secondment to Microsoft Research in Cambridge
7 I am taking up the challenge of migrating the current [GHC][ghc] build system
8 based on standard `make` into a new and (hopefully) better one based on
9 [Shake][shake]. If you are curious about the project you can find more details
10 on the [wiki page][ghc-shake-wiki] and in this [blog post][shake-blog-post].
11
12 This is supposed to go into the `shake-build` directory of the GHC source tree.
13
14 [Join us on #shaking-up-ghc on Freenode](irc://chat.freenode.net/#shaking-up-ghc)
15
16 Trying it
17 ---------
18
19 Please see the [Preparation][ghc-preparation] on the haskell wiki
20 for general preparation. The preparation steps for the `shake` build system are
21 identical to those for the `make` build system. This means that you don't need
22 to adjust anything if you are already familiar with building ghc using the `make`
23 build system.
24
25 ### Linux / Mac OS X
26
27 ```bash
28 git clone git://git.haskell.org/ghc
29 cd ghc
30 git submodule update --init
31 git clone git://github.com/snowleopard/shaking-up-ghc shake-build
32 ./boot
33 ./configure
34 ```
35
36 Now you have a couple of options:
37
38 - `./shake-build/build.sh` to run the script directly. You'll need to have
39   `shake` installed globally.
40 - `./shake-build/build.cabal.sh` to install the build system in a Cabal sandbox
41   and then run it.
42
43
44
45 ### Windows
46
47 ```bash
48 git clone --recursive git://git.haskell.org/ghc.git
49 cd ghc
50 git clone git://github.com/snowleopard/shaking-up-ghc shake-build
51 ./boot
52 ./configure --enable-tarballs-autodownload
53 shake-build/build.bat
54 ```
55 Also see the [Building GHC on Windows guide][ghc-windows-building-guide].
56
57 ### Resetting the build
58
59 To reset the new build system run the build script with `-B` flag. This forces Shake to rerun all rules, even if results of the previous build are still in the GHC tree. This is a temporary solution; we are working on a proper reset functionality (see [#32](https://github.com/snowleopard/shaking-up-ghc/issues/32)).
60
61
62 How to contribute
63 -----------------
64
65 The best way to contribute is to try the new build system, report the issues
66 you found, and attempt to fix them. Please note the codebase is very unstable
67 at present and we expect a lot of further refactoring. Before attempting to
68 fix any issue do make sure no one else is already working on it. The
69 documentation is currently non-existent, but we will start addressing this
70 once the codebase stabilises.
71
72
73 [ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
74 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
75 [ghc-windows-building-guide]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows
76 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
77 [shake-blog-post]: https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc
78 [shake]: https://github.com/ndmitchell/shake/blob/master/README.md