From f8764c73ecc8b226aaa00672f48eb7c0fc7b5cb1 Mon Sep 17 00:00:00 2001 From: Ɓukasz Hanuszczak Date: Tue, 25 Aug 2015 18:01:29 +0200 Subject: Add sample Stack setup to the hacking guide. --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 08b960de..367b70e8 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,20 @@ Please create issues when you have any problems and pull requests if you have so ###### Hacking -To get started you'll need a latest GHC release installed. Below is an -example setup using cabal sandboxes. +To get started you'll need a latest GHC release installed. + +Clone the repository: ```bash git clone https://github.com/haskell/haddock.git cd haddock +``` + +and then proceed using your favourite build tool. + +####### Using Cabal sandboxes + +```bash cabal sandbox init cabal sandbox add-source haddock-library cabal sandbox add-source haddock-api @@ -63,9 +71,21 @@ example setup using cabal sandboxes. cabal configure --enable-tests cabal build -j4 # run the test suite + export HADDOCK_PATH="dist/build/haddock/haddock" cabal test ``` +####### Using Stack + +```bash + stack init + stack install + # run the test suite + export HADDOCK_PATH="$HOME/.local/bin/haddock" + stack test +``` + + If you're a GHC developer and want to update Haddock to work with your changes, you should be working on `ghc-head` branch instead of master. See instructions at -- cgit v1.2.3