Update cabal instructions

This commit is contained in:
jneira 2021-06-18 23:19:00 +02:00
parent d9908f606f
commit 93da3433fb

View File

@ -36,16 +36,21 @@ That will generate a `<executable-name>.prof` plain text file with profiling dat
## Building with cabal
Unison can also be built/installed with cabal. You'll need ghc 8.6.x to
successfully build its dependencies. The provided project file is also in
contrib/ so you'll need to specify its location on the command line.
Unison can also be built/installed with cabal. You'll need the same ghc
used by `stack.yaml` to successfully build its dependencies.
The provided project file is also in contrib/ so you'll need to specify
its location on the command line.
* To configure the build, you can use e.g. `cabal v2-configure
--project-file=contrib/cabal.project --with-ghc=ghc-8.6.5` if you have
multiple versions of GHC installed
* To build all projects use `cabal v2-build --project-file=contrib/cabal.project all`
* Tests can be run with e.g. `cabal v2-run --project-file=contrib/cabal.project
parser-typechecker:tests`
* The executable can be installed with `cabal v2-install
--project-file=contrib/cabal.project unison` the install directory can be
modified by setting `installdir: ...` in `.cabal/config`
* To build all projects use
`cabal v2-build --project-file=contrib/cabal.project all`
* Tests can be run with e.g.
`cabal v2-test --project-file=contrib/cabal.project all`
* The executable can be installed with
`cabal v2-install --project-file=contrib/cabal.project unison`
* The install directory can be modified with the option `--installdir: ...`