Skip to content

Commit 037e7fe

Browse files
committed
Mention new installation stuff in README
1 parent e8812c1 commit 037e7fe

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ This is *very* early stage software.
1717
- [Haskell Language Server (HLS)](#haskell-language-server)
1818
- [Features](#features)
1919
- [Installation](#installation)
20+
- [Prerequisites](#prerequisites)
21+
- [Visual Studio Code](#visual-studio-code)
22+
- [Pre-built binaries](#pre-built-binaries)
2023
- [Installation from source](#installation-from-source)
2124
- [Common pre-requirements](#common-pre-requirements)
2225
- [Linux-specific pre-requirements](#linux-specific-pre-requirements)
@@ -54,7 +57,20 @@ This is *very* early stage software.
5457

5558
## Installation
5659

57-
For now only installation from source is supported.
60+
### Prerequisites
61+
62+
- For standalone `.hs`/`.lhs` files, [ghc](https://www.haskell.org/ghc/) must be installed and on the PATH. The easiest way to install it is with [ghcup](https://www.haskell.org/ghcup/) or [Chocolatey](https://www.haskell.org/platform/windows.html) on Windows.
63+
- For Cabal based projects, both ghc and [cabal-install](https://www.haskell.org/cabal/) must be installed and on the PATH. It can also be installed with [ghcup](https://www.haskell.org/ghcup/) or [Chocolatey](https://www.haskell.org/platform/windows.html) on Windows.
64+
- For Stack based projects, [stack](http://haskellstack.org) must be installed and on the PATH.
65+
66+
### Visual Studio Code
67+
68+
If you are using Visual Studio Code, the [Haskell extension](https://marketplace.visualstudio.com/items?itemName=alanz.vscode-hie-server) will automatically download and install `haskell-language-server` for you.
69+
70+
### Pre-built binaries
71+
72+
There are pre-built binaries available from the [releases page](https://github.com/haskell/haskell-language-server/releases) for Linux, Windows and macOS.
73+
To install, download the `haskell-language-server-wrapper` executable for your platform as well as any `haskell-language-server` executables for the GHC versions you plan on working with, and either put them on your PATH or point your client to them.
5874

5975
### Installation from source
6076

@@ -304,8 +320,7 @@ All of the editor integrations assume that you have already installed `haskell-l
304320

305321
Install from
306322
[the VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=alanz.vscode-hie-server), or manually from the repository [vscode-hie-server](https://github.com/alanz/vscode-hie-server).
307-
308-
Choose `haskell-language-server` in the extension setting `languageServerHaskell.hieVariant`.
323+
The `haskell-language-server` and `haskell-language-server-wrapper` binaries will be automatically downloaded on an ad-hoc basis, but if you have them already installed on your PATH then it will just use them instead.
309324

310325
### Using Haskell Language Server with Sublime Text
311326

0 commit comments

Comments
 (0)