Skip to content

Revise README.md #374

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 1 commit into from
Sep 3, 2020
Merged

Revise README.md #374

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 16 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[badge-circleci]: https://img.shields.io/circleci/project/github/haskell/haskell-language-server/master.svg
[circleci]: https://circleci.com/gh/haskell/haskell-language-server/

Integration point for [ghcide](https://github.com/digital-asset/ghcide) and [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine). One IDE to rule
Integration point for [ghcide](https://github.com/haskell/ghcide) and [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine). One IDE to rule
them all. Read the [project's
background](https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-them-all.html).

Expand Down Expand Up @@ -45,9 +45,11 @@ This is *very* early stage software.
- [Known limitations](#known-limitations)
- [Preprocessor](#preprocessor)
- [Contributing](#contributing)
- [It's time to join the project!](#its-time-to-join-the-project)
- [Building haskell-language-server](#building-haskell-language-server)
- [Hacking on haskell-language-server](#hacking-on-haskell-language-server)
- [Using Cabal](#using-cabal)
- [Using Stack](#using-stack)
- [Introduction tutorial](#instructions-tutorial)
- [Test your hacked HLS in your editor](#test-your-hacked-hls-in-your-editor)

## Features

Expand Down Expand Up @@ -363,9 +365,9 @@ The `haskell-language-server` and `haskell-language-server-wrapper` binaries wil
"command": ["haskell-language-server-wrapper", "--lsp"],
"scopes": ["source.haskell"],
"syntaxes": ["Packages/Haskell/Haskell.sublime-syntax"],
"languageId": "haskell",
},
},
"languageId": "haskell"
}
}
}
```

Expand All @@ -389,15 +391,15 @@ Then issue `:CocConfig` and add the following to your Coc config file.

```json
{
"languageserver": {
"haskell": {
"command": "haskell-language-server-wrapper",
"args": ["--lsp"],
"rootPatterns": ["*.cabal", "stack.yaml", "cabal.project", "package.yaml", "hie.yaml"],
"filetypes": ["haskell", "lhaskell"]
"languageserver": {
"haskell": {
"command": "haskell-language-server-wrapper",
"args": ["--lsp"],
"rootPatterns": ["*.cabal", "stack.yaml", "cabal.project", "package.yaml", "hie.yaml"],
"filetypes": ["haskell", "lhaskell"]
}
}
}
}
```

#### LanguageClient-neovim
Expand Down Expand Up @@ -543,13 +545,12 @@ Example with `tasty-discover`:
```
This returns an error in HLS if 'tasty-discover' is not in the path: `could not execute: tasty-discover`.


## Contributing

:heart: The Haskell tooling dream is near, we need your help! :heart:

- Join [our IRC channel](https://webchat.freenode.net/?channels=haskell-ide-engine) at `#haskell-ide-engine` on `freenode`.
- Fork this repo and [ghcide](https://github.com/digital-asset/ghcide) and hack as much as you can.
- Fork this repo and [ghcide](https://github.com/haskell/ghcide) and hack as much as you can.

### Building haskell-language-server

Expand Down