Skip to content

Commit 187f929

Browse files
jneiraalanz
authored andcommitted
Update hie build instructions
Closes #199 (cherry picked from commit 10c2247)
1 parent 41b2bcb commit 187f929

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,34 @@ Client interface to the Language Server Protocol server for Haskell, as provided
88

99
The language client requires you to manually install the [HIE](https://github.com/haskell/haskell-ide-engine) language server which can be done with commands below but this will take exceedingly long time and less than robust, consider proceeding to installation readme at the link below, it has option for getting bins directly,
1010

11+
Using stack:
12+
1113
```bash
1214
$ git clone https://github.com/haskell/haskell-ide-engine --recursive
1315
$ cd haskell-ide-engine && ./install.hs hie
1416
```
1517

18+
Using cabal:
19+
20+
```bash
21+
$ git clone https://github.com/haskell/haskell-ide-engine --recursive
22+
$ cd haskell-ide-engine && ./cabal-hie-install hie
23+
```
24+
1625
On Windows, it is advised to either install HIE at the root of the drive, and/or to enable [Win32 Long paths](https://github.com/haskell/haskell-ide-engine#windows-specific-pre-requirements).
1726

27+
Using stack:
28+
1829
```cmd
1930
C:\> git clone https://github.com/haskell/haskell-ide-engine --recursive hie
20-
C:\> cd hie && stack ./install.hs hie
31+
C:\> cd hie && stack .\install.hs hie
32+
```
33+
34+
Using cabal:
35+
36+
```cmd
37+
C:\> git clone https://github.com/haskell/haskell-ide-engine --recursive hie
38+
C:\> cd hie && .\cabal-hie-install hie
2139
```
2240

2341
If you experience difficulties, use the instructions at https://github.com/haskell/haskell-ide-engine#installation
@@ -43,6 +61,7 @@ Additionally the language server itself features,
4361
* Fast due to caching of compile info
4462

4563
## Supported GHC versions
64+
4665
vscode-hie-server depends on haskell-ide-engine to support different versions of GHC. At the moment of writing the following versions are supported: 8.4, 8.6 and 8.8. If your project uses any other GHC version it won't work.
4766

4867
## Extension Settings
@@ -185,11 +204,11 @@ This provides a very flexible way of customizing your setup.
185204

186205
## Investigating and reporting problems
187206

188-
1. Go to extensions and right click `Haskell Language Server` and choose `Configure Extensions Settings`
189-
2. Scroll down to `Language Server Haskell › Trace: Server` and set it to `verbose`
190-
3. Restart vscode and reproduce your problem
191-
4. Go to the main menu and choose `View -> Output` (`Ctrl + Shift + U`)
192-
5. On the new Output panel that opens on the right side in the drop down menu choose `Haskell HIE (cabal)`
207+
1. Go to extensions and right click `Haskell Language Server` and choose `Configure Extensions Settings`
208+
2. Scroll down to `Language Server Haskell › Trace: Server` and set it to `verbose`
209+
3. Restart vscode and reproduce your problem
210+
4. Go to the main menu and choose `View -> Output` (`Ctrl + Shift + U`)
211+
5. On the new Output panel that opens on the right side in the drop down menu choose `Haskell HIE (cabal)`
193212

194213
Now you will see the information which you can use to diagnose or report a problem
195214

0 commit comments

Comments
 (0)