From eddbe29803d11ba684a270dca75c4684a8f0f27e Mon Sep 17 00:00:00 2001 From: Pepe Iborra Date: Sat, 9 Jan 2021 19:37:14 +0000 Subject: [PATCH 1/3] Installation from Hackage - add README section --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1c53b320b1..a9479de09a 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ background](https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-th - [Building](#building) - [Install via cabal](#install-via-cabal) - [Install specific GHC Version](#install-specific-ghc-version) + - [Installation from Hackage](#installation-from-hackage) - [Configuring haskell-language-server](#configuring-haskell-language-server) - [Configuring your project build](#configuring-your-project-build) - [Configuring your editor](#configuring-your-editor) @@ -164,6 +165,7 @@ cd haskell-language-server #### Building + Note, on first invocation of the build script with stack, a GHC is being installed for execution. The GHC used for the `install.hs` can be adjusted in `./install/stack.yaml` by using a different resolver. @@ -245,6 +247,12 @@ If your desired ghc has been found, you use it to install haskell-language-serve ./cabal-hls-install hls-8.6.5 ``` +### Installation from Hackage + +Direct installation from Hackage is supported via `cabal install haskell-language-server`. +This builds the `haskell-language-server` binary and installs it in the default Cabal binaries folder. +This binary will only work against the same GHC version that was used to build it. + ## Configuring `haskell-language-server` Language servers like `haskell-language-server` expose most of their configuration via the client (i.e. the editor). From 91796fba7c196fcc71d3748c4ab6ab74de401a98 Mon Sep 17 00:00:00 2001 From: Pepe Iborra Date: Sat, 9 Jan 2021 20:05:16 +0000 Subject: [PATCH 2/3] Discourage direct installation from Hackage --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a9479de09a..b91f4374aa 100644 --- a/README.md +++ b/README.md @@ -249,9 +249,9 @@ If your desired ghc has been found, you use it to install haskell-language-serve ### Installation from Hackage -Direct installation from Hackage is supported via `cabal install haskell-language-server`. -This builds the `haskell-language-server` binary and installs it in the default Cabal binaries folder. -This binary will only work against the same GHC version that was used to build it. +Direct installation from Hackage, while possible via `cabal install haskell-language-server`, is not recommended for most people. +Said command builds the `haskell-language-server` binary and installs it in the default Cabal binaries folder, +but the binary will only work with projects that use the same GHC version that built it. ## Configuring `haskell-language-server` From 8f3e22dafbc9a6ae34d5a46140d6e9f635ab1740 Mon Sep 17 00:00:00 2001 From: Pepe Iborra Date: Sat, 9 Jan 2021 20:05:50 +0000 Subject: [PATCH 3/3] remove random whitespace --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index b91f4374aa..c604295be1 100644 --- a/README.md +++ b/README.md @@ -165,7 +165,6 @@ cd haskell-language-server #### Building - Note, on first invocation of the build script with stack, a GHC is being installed for execution. The GHC used for the `install.hs` can be adjusted in `./install/stack.yaml` by using a different resolver.