aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBartosz Nitka <bnitka@fb.com>2015-06-07 08:40:59 -0700
committerBartosz Nitka <bnitka@fb.com>2015-06-07 08:40:59 -0700
commitfb5d8584779da51521e8bf745e8627b5ddf3724d (patch)
tree30f5cf2fd6299bb3d517f9dfb423a1df89dd56cd
parentd50967d6a20ec43b048b69122590b410ea872dc4 (diff)
Add some Hacking docs for getting started
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index b85d99b7..fba02bde 100644
--- a/README.md
+++ b/README.md
@@ -45,3 +45,22 @@ format.
#### Contributing
Please create issues when you have any problems and pull requests if you have some code.
+
+###### Hacking
+
+To get started you'll need a latest GHC release installed.
+
+ git clone https://github.com/haskell/haddock.git
+ cd haddock
+ cabal sandbox init
+ cabal sandbox add-source haddock-library
+ cabal sandbox add-source haddock-api
+ # adjust -j to the number of cores you want to use
+ cabal install -j4 --dependencies-only --enable-tests
+ cabal configure --enable-tests
+ cabal build -j4
+ # run the test suite
+ cabal test
+
+If you want to build against `GHC HEAD`, `ghc-head` is the corresponding branch.
+Note that it doesn't have to be up to date.