Update README.md
[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) [![Build status](https://ci.appveyor.com/api/projects/status/9er74sbnrkco98gb?svg=true&pendingText=Windows&passingText=Windows&failingText=Windows)](https://ci.appveyor.com/project/snowleopard/shaking-up-ghc)
5
6
7 As part of my 6-month research secondment to Microsoft Research in Cambridge
8 I am taking up the challenge of migrating the current [GHC][ghc] build system
9 based on standard `make` into a new and (hopefully) better one based on
10 [Shake][shake]. If you are curious about the project you can find more details
11 on the [wiki page][ghc-shake-wiki] and in this [blog post][shake-blog-post].
12
13 This is supposed to go into the `shake-build` directory of the GHC source tree.
14
15 [Join us on #shaking-up-ghc on Freenode](irc://chat.freenode.net/#shaking-up-ghc)
16
17 Trying it
18 ---------
19
20 Please see the [Preparation][ghc-preparation] on the haskell wiki
21 for general preparation. The preparation steps for the `shake` build system are
22 identical to those for the `make` build system. This means that you don't need
23 to adjust anything if you are already familiar with building ghc using the `make`
24 build system.
25
26 ### Getting the source and configuring GHC
27
28 ```bash
29 git clone --recursive git://git.haskell.org/ghc.git
30 cd ghc
31 git clone git://github.com/snowleopard/shaking-up-ghc shake-build
32 ./boot
33 ./configure                                # on linux / os x
34 ./configure --enable-tarballs-autodownload # on windows
35 ```
36
37 ### Configuring the build process
38
39 `ghc` uses `mk/build.mk` to configure the build process. `shaking-up-ghc`
40 uses `src/Settings/User.hs` for build specification.
41
42 ### Building GHC using `shaking-up-ghc`
43
44 ```bash
45 ./shake-build/build.sh       # linux / os x: to run the script directly. You'll need to have `shake` installed globally.
46 ./shake-build/build.cabal.sh # linux / os x: OR to install the build system in a Cabal sandbox and then run it.
47 shake-build/build.bat        # windows
48 ```
49
50 Also see the [Building GHC on Windows guide][ghc-windows-building-guide].
51
52 ### Resetting the build
53
54 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)).
55
56
57 How to contribute
58 -----------------
59
60 The best way to contribute is to try the new build system, report the issues
61 you found, and attempt to fix them. Please note the codebase is very unstable
62 at present and we expect a lot of further refactoring. Before attempting to
63 fix any issue do make sure no one else is already working on it. The
64 documentation is currently non-existent, but we will start addressing this
65 once the codebase stabilises.
66
67
68 [ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
69 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
70 [ghc-windows-building-guide]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows
71 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
72 [shake-blog-post]: https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc
73 [shake]: https://github.com/ndmitchell/shake/blob/master/README.md