Add Cabal support for sandboxed build system building
[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 make inplace/bin/ghc-cabal   # This needs to be fixed
29 ```
30
31 Now you have a couple of options:
32
33 - `./shake-build/build.sh` to run the script directly. You'll need to have
34   `shake` installed globally.
35 - `./shake-build/build.cabal.sh` to install the build system in a Cabal sandbox
36   and then run it.
37
38
39
40 ### Windows
41
42 ```
43 $ git clone --recursive git://git.haskell.org/ghc.git
44 $ cd ghc
45 $ git clone git://github.com/snowleopard/shaking-up-ghc shake-build
46 $ ./boot
47 $ ./configure --enable-tarballs-autodownload
48 $ make inplace/bin/ghc-cabal   # This needs to be fixed
49 $ shake-build/build.bat
50 ```
51 Also see the [Building GHC on Windows guide][ghc-windows-building-guide].
52
53
54
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
69
70
71 [ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
72 [ghc-windows-building-guide]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows
73 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
74 [shake-blog-post]: https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc
75 [shake]: https://github.com/ndmitchell/shake/blob/master/README.md