Skip to content

Commit 043abcb

Browse files
authored
Merge pull request #419 from haskell/jneira-update-readme
Mention the copy of executables with ghc version
2 parents b43a8cd + e143c13 commit 043abcb

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,12 @@ For brevity, only the `stack`-based commands are presented in the following sect
194194

195195
##### Install specific GHC Version
196196

197+
The script will install the executables `haskell-language-server-wrapper` and `haskell-language-server`.
198+
It will copy the latter appending the used ghc version, needed by the wrapper to choose the suitable version
199+
for the project at hand.
200+
So installing the executables directly with `stack install` or `cabal v2-install` may not be enough
201+
for it to work properly.
202+
197203
Install haskell-language-server for the latest available and supported GHC version (and hoogle docs):
198204

199205
```bash
@@ -207,6 +213,9 @@ stack ./install.hs hls-8.8.3
207213
stack ./install.hs data
208214
```
209215

216+
`hls-8.8.3` target will build the project and install `haskell-language-server-wrapper`,
217+
`haskell-language-server`, `haskell-language-server-8.8.3` and `haskell-language-server-8.8`
218+
executables.
210219
The Haskell Language Server can also be built with `cabal v2-build` instead of `stack build`.
211220
This has the advantage that you can decide how the GHC versions have been installed.
212221
To see what GHC versions are available, the command `cabal-hls-install ghcs` can be used.
@@ -600,4 +609,3 @@ To do every time you changed code and want to test it:
600609
- With Stack: `stack build haskell-language-server:exe:haskell-language-server`
601610
- Restart HLS
602611
- With VS Code: `Haskell: Restart Haskell LSP Server`
603-

0 commit comments

Comments
 (0)