diff --git a/LICENCE.txt b/LICENSE.txt similarity index 100% rename from LICENCE.txt rename to LICENSE.txt diff --git a/README.md b/README.md index a207582..7e6f210 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,13 @@ Usually the client has responsibility to start the server. They first communicat ## Getting Started +You can either [download](https://oss.sonatype.org/content/repositories/snapshots/io/smartdatalake/sdl-lsp/1.0-SNAPSHOT/) the jar and jump directly to [Setting a basic LSP client in Intellij](#Setting-a-basic-LSP-client-in-Intellij) or compile and generate the jar yourself. + +To download it, go [here](https://oss.sonatype.org/content/repositories/snapshots/io/smartdatalake/sdl-lsp/1.0-SNAPSHOT/) and take the one finishing with `XXX-jar-with-dependencies.jar`. +You can now read [Setting a basic LSP client in Intellij](#Setting-a-basic-LSP-client-in-Intellij). + +If you prefer build the jar, follow the instructions below. + ### Dependencies To be able to build an executable jar with this project, you will need: * maven @@ -32,6 +39,7 @@ To be able to build an executable jar with this project, you will need: * Click on the gear aside `Marketplace` and `Installed` and click on `Install Plugin from disk...`. Add the downloaded plugin. * Go to `Settings > Languages & Frameworks > Language Server Protocol > Server definitions` * Choose `Raw command | Extension: conf | Command: java -jar ${path-to-project}/target/sdl-lsp-1.0-SNAPSHOT-jar-with-dependencies.jar`. Be sure you ran `mvn clean package` before. +Please adapt the name if you downloaded the jar. * A red, yellow or green dot should have appeared in the bottom of your IDE. Red just means the LSP is inactive, yellow means the LSP is initializing and green means up and running. You can check timeouts, restart the server or check the connected files. @@ -39,10 +47,4 @@ To be able to build an executable jar with this project, you will need: [scalathe](https://github.com/dsalathe) ## License -TODO - -This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details - -## Acknowledgments - -TODO \ No newline at end of file +This project is licensed under the GNU General Public License (GPL) version 3 - see the LICENSE.txt file for details diff --git a/pom.xml b/pom.xml index 60463c9..fc2fe31 100644 --- a/pom.xml +++ b/pom.xml @@ -205,6 +205,9 @@ + org.codehaus.mojo exec-maven-plugin