Add instructions about install cabal with stack

and update instructions to run the build script with cabal on windows
This commit is contained in:
Javier Neira 2019-10-16 08:59:57 +02:00 committed by GitHub
parent 53acb90400
commit 7ab685b91a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -212,12 +212,22 @@ The install-script can be invoked via `cabal` instead of `stack` with the comman
cabal v2-run ./install.hs --project-file install/shake.project <target>
```
Running the script with cabal on windows seems to have some issues and is currently not fully supported.
Running the script with cabal on windows requires a cabal version greater or equal to `3.0.0.0`.
Unfortunately, it is still required to have `stack` installed so that the install-script can locate the `local-bin` directory (on Linux `~/.local/bin`) and copy the `hie` binaries to `hie-x.y.z`, which is required for the `hie-wrapper` to function as expected.
For brevity, only the `stack`-based commands are presented in the following sections.
##### Install cabal using stack
Although you can use hie for stack based projects (those which have a `stack.yaml` in the project base directory) without having cabal installed, you will need it for cabal based projects (with only a `<projectName>.cabal` file or a `cabal.project` one in the project base directory).
You can install an appropiate cabal version using stack by running:
```bash
stack ./install.hs stack-install-cabal
```
##### Install specific GHC Version
Install **Nightly** (and hoogle docs):