Remove `make inplace/bin/ghc-cabal` (see #23)
[hadrian.git] / README.md
1 Shaking up GHC
2 ==============
3
4 As part of my 6-month research secondment to Microsoft Research in Cambridge
5 I am taking up the challenge of migrating the current [GHC][ghc] build system
6 based on standard `make` into a new and (hopefully) better one based on
7 [Shake][shake]. If you are curious about the project you can find more details
8 on the [wiki page][ghc-shake-wiki] and in this [blog post][shake-blog-post].
9
10 This is supposed to go into the `shake-build` directory of the GHC source tree.
11
12
13
14
15
16 Trying it
17 ---------
18
19 ### Linux
20
21 ```bash
22 git clone git://git.haskell.org/ghc
23 cd ghc
24 git submodule update --init
25 git clone git://github.com/snowleopard/shaking-up-ghc shake-build
26 ./boot
27 ./configure
28 ```
29
30 Now you have a couple of options:
31
32 - `./shake-build/build.sh` to run the script directly. You'll need to have
33   `shake` installed globally.
34 - `./shake-build/build.cabal.sh` to install the build system in a Cabal sandbox
35   and then run it.
36
37
38
39 ### Windows
40
41 ```
42 $ git clone --recursive git://git.haskell.org/ghc.git
43 $ cd ghc
44 $ git clone git://github.com/snowleopard/shaking-up-ghc shake-build
45 $ ./boot
46 $ ./configure --enable-tarballs-autodownload
47 $ shake-build/build.bat
48 ```
49 Also see the [Building GHC on Windows guide][ghc-windows-building-guide].
50
51
52
53
54
55 How to contribute
56 -----------------
57
58 The best way to contribute is to try the new build system, report the issues
59 you found, and attempt to fix them. Please note the codebase is very unstable
60 at present and we expect a lot of further refactoring. Before attempting to
61 fix any issue do make sure no one else is already working on it. The
62 documentation is currently non-existent, but we will start addressing this
63 once the codebase stabilises.
64
65
66
67
68
69 [ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
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