diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 22 insertions, 2 deletions
@@ -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 |