From 0b5a59a94f7d03df5d833c93ffd75b3f8d5bd5ba Mon Sep 17 00:00:00 2001 From: Łukasz Hanuszczak Date: Mon, 24 Aug 2015 23:18:50 +0200 Subject: Update sandbox setup guide to work with Haddock test package. --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 31015e91..08b960de 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,7 @@ example setup using cabal sandboxes. cabal sandbox init cabal sandbox add-source haddock-library cabal sandbox add-source haddock-api + cabal sandbox add-source haddock-test # adjust -j to the number of cores you want to use cabal install -j4 --dependencies-only --enable-tests cabal configure --enable-tests -- cgit v1.2.3 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(-) (limited to 'README.md') 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 From e6fd9fc7f23a1be317ad045da5f8248866f80308 Mon Sep 17 00:00:00 2001 From: Łukasz Hanuszczak Date: Tue, 25 Aug 2015 18:04:47 +0200 Subject: Fix Markdown formatting of README file. --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 367b70e8..160ee995 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ format. Please create issues when you have any problems and pull requests if you have some code. -###### Hacking +##### Hacking To get started you'll need a latest GHC release installed. @@ -59,30 +59,30 @@ Clone the repository: and then proceed using your favourite build tool. -####### Using Cabal sandboxes +###### Using Cabal sandboxes ```bash - cabal sandbox init - cabal sandbox add-source haddock-library - cabal sandbox add-source haddock-api - cabal sandbox add-source haddock-test - # 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 - export HADDOCK_PATH="dist/build/haddock/haddock" - cabal test +cabal sandbox init +cabal sandbox add-source haddock-library +cabal sandbox add-source haddock-api +cabal sandbox add-source haddock-test +# 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 +export HADDOCK_PATH="dist/build/haddock/haddock" +cabal test ``` -####### Using Stack +###### Using Stack ```bash - stack init - stack install - # run the test suite - export HADDOCK_PATH="$HOME/.local/bin/haddock" - stack test +stack init +stack install +# run the test suite +export HADDOCK_PATH="$HOME/.local/bin/haddock" +stack test ``` -- cgit v1.2.3