summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeigh McCulloch <leigh@mcchouse.com>2019-02-17 23:57:45 +0000
committerGeorge Fraser <george@fivetran.com>2019-02-17 16:18:04 -0800
commitb9b74cc01be266ce21c352cd2be0cd4499361407 (patch)
tree00d9c063c88dcd471f927e16e5a2f459da23acfa
parent0ac7209274c92c7e039224d0d0bc2b197cf0eef8 (diff)
downloadjava-language-server-b9b74cc01be266ce21c352cd2be0cd4499361407.zip
Add installation instructions for vim
What === Add installation instructions for vim using the vim plugin vim-lsc. Why === This tool works great in vim but it isn't straight forward setting it up. These instructions will help others get off the ground using this tool with vim.
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index ec8d7a2..26467c3 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,28 @@
# Language Server for Java using the [Java compiler API](https://docs.oracle.com/javase/10/docs/api/jdk.compiler-summary.html)
-A Java [language server](https://github.com/Microsoft/vscode-languageserver-protocol) implemented using the Java compiler API.
+A Java [language server](https://github.com/Microsoft/vscode-languageserver-protocol) based on v3.0 of the protocol and implemented using the Java compiler API.
[![CircleCI](https://circleci.com/gh/georgewfraser/java-language-server.png)](https://circleci.com/gh/georgewfraser/java-language-server)
-## Installation
+## Installation (VS Code)
[Install from the VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=georgewfraser.vscode-javac)
+## Installation (other editors)
+
+### Vim (with vim-lsc)
+
+- Checkout this repository
+- Run `./scripts/link_mac.sh`
+- Add the vim plugin [natebosch/vim-lsc](https://github.com/natebosch/vim-lsc) to your vimrc
+- Add vim-lsc configuration:
+ ```vimrc
+ let g:lsc_server_commands = {'java': '<path-to-java-language-server>/java-language-server/dist/mac/bin/launcher --quiet'}
+ ```
+- See the [vim-lsc README](https://github.com/natebosch/vim-lsc/blob/master/README.md) for other configuration options.
+
+Note: This tool is not compatible with [vim-lsp](https://github.com/prabirshrestha/vim-lsp) as it only supports LSPv2.0.
+
## [Issues](https://github.com/georgewfraser/java-language-server/issues)
## Features