aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVladislav Zavialov <vlad.z.4096@gmail.com>2021-01-24 18:33:33 +0300
committerHécate Moonlight <hecate+github@glitchbra.in>2021-02-05 14:53:00 +0100
commitfcf9a04224fed910d01cf6f4d9c2d1bdc7c085af (patch)
treea167e8a62769fbf5c6f6bc3d15131499046bf8c9 /README.md
parent664122f108c25fa2e96c9ea6d012d11d8faa2229 (diff)
Update cabal.project and README build instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 5 insertions, 19 deletions
diff --git a/README.md b/README.md
index e9ff09ca..d19113c9 100644
--- a/README.md
+++ b/README.md
@@ -41,11 +41,13 @@ Note: before building `haddock`, you need to build the subprojects
`haddock-library` and `haddock-api`, in this order!
The `cabal v2-build` takes care of this automatically.
-#### Using [`cabal v2-build`][cabal v2]
+#### Using `cabal`
+
+Requires cabal `>= 3.4` and GHC `== 9.0`:
```bash
-cabal v2-build -w ghc-8.10.1
-cabal v2-test -w ghc-8.10.1 all
+cabal build all --enable-tests
+cabal test all
```
#### Using `stack`
@@ -57,22 +59,6 @@ export HADDOCK_PATH="$(stack exec which haddock)"
stack test
```
-#### Using Cabal sandboxes (deprecated)
-
-```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
-```
-
### Git Branches
If you're a GHC developer and want to update Haddock to work with your changes,