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

Commit 623f8f6

Browse files
authored
Merge pull request #1414 from haskell/jneira-update-readme
Add instructions about install cabal with stack and update instructions to run the build script with cabal on windows in the README
2 parents 53acb90 + 7ab685b commit 623f8f6

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,12 +212,22 @@ The install-script can be invoked via `cabal` instead of `stack` with the comman
212212
cabal v2-run ./install.hs --project-file install/shake.project <target>
213213
```
214214

215-
Running the script with cabal on windows seems to have some issues and is currently not fully supported.
215+
Running the script with cabal on windows requires a cabal version greater or equal to `3.0.0.0`.
216216

217217
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.
218218

219219
For brevity, only the `stack`-based commands are presented in the following sections.
220220

221+
##### Install cabal using stack
222+
223+
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).
224+
225+
You can install an appropiate cabal version using stack by running:
226+
227+
```bash
228+
stack ./install.hs stack-install-cabal
229+
```
230+
221231
##### Install specific GHC Version
222232

223233
Install **Nightly** (and hoogle docs):

0 commit comments

Comments
 (0)