Skip to content
This repository has been archived by the owner on Oct 7, 2020. It is now read-only.

Add instructions about install cabal with stack in the README #1414

Merged
merged 1 commit into from
Oct 16, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down