Adds integer gmp path to the Gcc builder.
[hadrian.git] / README.md
index 3c42074..f26cc49 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,14 +9,18 @@ on the [wiki page][ghc-shake-wiki] and in this [blog post][shake-blog-post].
 
 This is supposed to go into the `shake-build` directory of the GHC source tree.
 
-
-
-
+[Join us on #shaking-up-ghc on Freenode](irc://chat.freenode.net/#shaking-up-ghc)
 
 Trying it
 ---------
 
-### Linux
+Please see the [Preparation][ghc-preparation] on the haskell wiki
+for general preparation. The preparation steps for the `shake` build system are
+identical to those for the `make` build system. This means that you don't need
+to adjust anything if you are already familiar with building ghc using the `make`
+build system.
+
+### Linux / Mac OS X
 
 ```bash
 git clone git://git.haskell.org/ghc
@@ -25,7 +29,9 @@ git submodule update --init
 git clone git://github.com/snowleopard/shaking-up-ghc shake-build
 ./boot
 ./configure
-make inplace/bin/ghc-cabal   # This needs to be fixed
+# or if you want to use clang (e.g. building on OS X)
+./configure --with-gcc=$(which clang) # See #26
+
 ```
 
 Now you have a couple of options:
@@ -39,19 +45,19 @@ Now you have a couple of options:
 
 ### Windows
 
-```
-$ git clone --recursive git://git.haskell.org/ghc.git
-$ cd ghc
-$ git clone git://github.com/snowleopard/shaking-up-ghc shake-build
-$ ./boot
-$ ./configure --enable-tarballs-autodownload
-$ make inplace/bin/ghc-cabal   # This needs to be fixed
-$ shake-build/build.bat
+```bash
+git clone --recursive git://git.haskell.org/ghc.git
+cd ghc
+git clone git://github.com/snowleopard/shaking-up-ghc shake-build
+./boot
+./configure --enable-tarballs-autodownload
+shake-build/build.bat
 ```
 Also see the [Building GHC on Windows guide][ghc-windows-building-guide].
 
+### Resetting the build
 
-
+To reset the new build system run the build script with `-B` flag. This will force Shake to rerun all rules, even if the 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)).
 
 
 How to contribute
@@ -65,11 +71,9 @@ documentation is currently non-existent, but we will start addressing this
 once the codebase stabilises.
 
 
-
-
-
 [ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
+[ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
 [ghc-windows-building-guide]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows
 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
 [shake-blog-post]: https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc
-[shake]: https://github.com/ndmitchell/shake/blob/master/README.md
\ No newline at end of file
+[shake]: https://github.com/ndmitchell/shake/blob/master/README.md