Skip to content

Update hie build instructions #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 5, 2020
Merged

Update hie build instructions #207

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d06bb4d
Update hie build instructions
jneira Feb 5, 2020
44a971c
Replace mention to old make script
jneira Feb 5, 2020
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
35 changes: 26 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,36 @@ Client interface to the Language Server Protocol server for Haskell, as provided

## Requirements

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,
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:

* using stack:

```bash
$ git clone https://github.com/haskell/haskell-ide-engine --recursive
$ cd haskell-ide-engine && ./install.hs hie
```

* using cabal:

```bash
$ git clone https://github.com/haskell/haskell-ide-engine --recursive
$ cd haskell-ide-engine && ./install.hs build
$ cd haskell-ide-engine && ./cabal-hie-install hie
```

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):

* using stack:

```cmd
C:\> git clone https://github.com/haskell/haskell-ide-engine --recursive hie
C:\> cd hie && stack .\install.hs hie
```

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).
* using cabal:

```cmd
C:\> git clone https://github.com/haskell/haskell-ide-engine --recursive hie
C:\> cd hie && stack ./install.hs build
C:\> cd hie && .\cabal-hie-install hie
```

If you experience difficulties, use the instructions at https://github.com/haskell/haskell-ide-engine#installation
Expand Down Expand Up @@ -60,11 +78,10 @@ process haskell files on save.

#### HIE Wrapper

Furthermore, the extension supports multiple ways of initializing hie,
depending on your needs. The default one uses the `hie-vscode.[sh|bat]`
file to start hie through. This will attempt to start via `hie-wrapper`
if it is on the vscode path, otherwise fall back to `hie`.
The`hie-wrapper` executable is installed using `make build`,
Furthermore, the extension supports multiple ways of initializing hie, depending on your needs.
The default one uses the `hie-vscode.[sh|bat]` file to start hie through.
This will attempt to start via `hie-wrapper` if it is on the vscode path, otherwise fall back to `hie`.
The`hie-wrapper` executable is installed using `stack ./install.hs hie` or `./cabal-hie-install hie`,
together with the other GHC version specific `hie-8.x` executables.
This will take precedence over `hieExecutablePath`.

Expand Down