Mon Nov 20 20:55:14 UTC 2017

Repository : ssh://git@git.haskell.org/haddock

On branches: 2.17.3.1-spanfix,alexbiehl-patch-1,ghc-8.0,ghc-8.0-facebook,ghc-head,ghc-head1,haddock-quick,headdock-library-1.4.5,ie_avails,issue-303,issue-475,master,pr-filter-maps,pr/cabal-desc,travis,v2.17,v2.17.3,v2.18,wip-located-module-as,wip/D2418,wip/T11080-open-data-kinds,wip/T11430,wip/T12105,wip/T12105-2,wip/T12942,wip/T13163,wip/T3384,wip/embelleshed-rdr,wip/new-tree-one-param,wip/rae,wip/remove-frames,wip/remove-frames1,wip/revert-ttg-2017-11-20,wip/ttg-2017-10-13,wip/ttg-2017-10-31,wip/ttg-2017-11-06,wip/ttg2-2017-11-10,wip/ttg3-2017-11-12,wip/ttg4-constraints-2017-11-13
Link       : http://git.haskell.org/haddock.git/commitdiff/f8764c73ecc8b226aaa00672f48eb7c0fc7b5cb1

>---------------------------------------------------------------

commit f8764c73ecc8b226aaa00672f48eb7c0fc7b5cb1
Author: Łukasz Hanuszczak <lukasz.hanuszczak at gmail.com>
Date:   Tue Aug 25 18:01:29 2015 +0200

    Add sample Stack setup to the hacking guide.


>---------------------------------------------------------------

f8764c73ecc8b226aaa00672f48eb7c0fc7b5cb1
 README.md | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 08b960d..367b70e 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

