Skip to content

Commit 1c7b89c

Browse files
authored
Update readme (#886)
Fix dead links: * contributing * changelog Remove links to: * type information and documentation on hover * Chocolatey Update supported ghc versions paragraph, now contains a link to the ghc versions supported by hls and no longer contains its own table.
1 parent 69c4268 commit 1c7b89c

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

README.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ managed by the Extension, you will have to follow the [installation instructions
4646
You can watch demos for some of these features [here](https://haskell-language-server.readthedocs.io/en/latest/features.html#demos).
4747

4848
- Warning and error diagnostics from GHC
49-
- Type information and documentation on hover, [including your own comments](./configuration.md#how-to-show-local-documentation-on-hover).
49+
- Type information and documentation on hover
5050
- Jump to definition: [for now only for local code definitions](https://github.com/haskell/haskell-language-server/issues/708)
5151
- Document symbols
5252
- Highlight references in document
@@ -64,7 +64,7 @@ You can watch demos for some of these features [here](https://haskell-language-s
6464

6565
## Requirements
6666

67-
- 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.
67+
- 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/).
6868
- 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.
6969
- For Stack based projects, [stack](http://haskellstack.org) must be installed and on the PATH and must be [configured to use GHC binaries installed by GHCup](https://www.haskell.org/ghcup/guide/#stack-integration).
7070
- If you are installing from an offline VSIX file, you need to install [language-haskell](https://github.com/JustusAdam/language-haskell) too after installation (either from the marketplace or offline).
@@ -206,20 +206,13 @@ At last, if you don't want `ghcup` to manage any of the external tools except `h
206206

207207
### Supported GHC versions
208208

209-
These are the versions of GHC that there are binaries of `haskell-language-server-1.7.0` for. [Building from source](https://haskell-language-server.readthedocs.io/en/latest/installation.html) may support more versions!
209+
You can check each GHC version's support status and the policy followed for deprecations [here](https://haskell-language-server.readthedocs.io/en/latest/support/ghc-version-support.html).
210210

211-
| GHC | Linux | macOS | Windows |
212-
| --------------------------------------------------------------------------------- | ----- | ----- | ------- |
213-
| 9.2.2 ([limited](https://github.com/haskell/haskell-language-server/issues/2179)) ||||
214-
| 9.2.1 ([limited](https://github.com/haskell/haskell-language-server/issues/2179)) ||||
215-
| 9.0.2 ([limited](https://github.com/haskell/haskell-language-server/issues/297)) ||||
216-
| 8.10.7 ||||
217-
| 8.8.4 ||||
218-
| 8.6.5 ||||
211+
[Building from source](https://haskell-language-server.readthedocs.io/en/latest/installation.html) may support more versions!
219212

220213
The exact list of binaries can be checked in the last release of haskell-language-server: <https://github.com/haskell/haskell-language-server/releases/latest>
221214

222-
You can check the current GHC versions support status and the policy followed for deprecations [here](https://haskell-language-server.readthedocs.io/en/latest/supported-versions.html).
215+
223216

224217
## Using multi-root workspaces
225218

@@ -300,8 +293,8 @@ Also make sure GHCup is installed and in `$PATH`. If you're not starting VSCode
300293

301294
## Contributing
302295

303-
If you want to help, get started by reading [Contributing](https://github.com/haskell/vscode-haskell/blob/master/Contributing.md) for more details.
296+
If you want to help, get started by reading [Contributing](./docs/Contributing.md) for more details.
304297

305298
## Release Notes
306299

307-
See the [Changelog](https://github.com/haskell/vscode-haskell/blob/master/Changelog.md) for more details.
300+
See the [Changelog](./Changelog.md) for more details.

0 commit comments

Comments
 (0)