Update README.md
authorMoritz Angermann <moritz.angermann@gmail.com>
Thu, 7 Jan 2016 13:37:46 +0000 (21:37 +0800)
committerMoritz Angermann <moritz.angermann@gmail.com>
Thu, 7 Jan 2016 13:37:46 +0000 (21:37 +0800)
- Trying to unify Linux / OS X / Windows build steps.
- Added note about `src/Settings/User.hs`.
[skip ci]

README.md

index 9f9de91..6a89dc6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -23,36 +23,30 @@ 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
+### Getting the source and configuring GHC
 
 ```bash
-git clone git://git.haskell.org/ghc
+git clone --recursive git://git.haskell.org/ghc.git
 cd ghc
-git submodule update --init
 git clone git://github.com/snowleopard/shaking-up-ghc shake-build
 ./boot
-./configure
+./configure                                # on linux / os x
+./configure --enable-tarballs-autodownload # on windows
 ```
 
-Now you have a couple of options:
-
-- `./shake-build/build.sh` to run the script directly. You'll need to have
-  `shake` installed globally.
-- `./shake-build/build.cabal.sh` to install the build system in a Cabal sandbox
-  and then run it.
+### Configuring the build process
 
+`ghc` uses `mk/build.mk` to configure the build process. `shaking-up-ghc`
+uses `src/Settings/User.hs` for build specification.
 
-
-### Windows
+### Building GHC using `shaking-up-ghc`
 
 ```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
+./shake-build/build.sh       # linux / os x: to run the script directly. You'll need to have `shake` installed globally.
+./shake-build/build.cabal.sh # linux / os x: OR to install the build system in a Cabal sandbox and then run it.
+shake-build/build.bat        # windows
 ```
+
 Also see the [Building GHC on Windows guide][ghc-windows-building-guide].
 
 ### Resetting the build