Promote end-user usage instruction more in the README #1887
Conversation
|
Can one of the admins verify this patch? |
README.md
Outdated
| ---------------------------- | ||
|
|
||
| 6. Choosing a value for `-configuration`: this is the path to your platform's configuration directory. For linux, use `./config_linux`. For windows, use `./config_win`. For mac/OS X, use `./config_mac`. | ||
| **Pre-requisite: Java 11 must be installed on your machine and configured in Eclipse.** | ||
|
|
||
| 7. Choosing a value for `-data`: the value for your data directory, should be the directory where your active workspace is, and you wish for the java langserver to add in its default files. Should also be the absolute path to this directory, ie., /home/username/workspace | ||
| 0. Fork and clone the repository | ||
| 1. Install [Eclipse IDE for Eclipse Committers](https://www.eclipse.org/downloads/packages/release/2018-09/r/eclipse-ide-eclipse-committers) that will have the most needed plugins already installed. Alternatively, | ||
| you can get the [Eclipse IDE for Java developers](https://www.eclipse.org/downloads/packages/release/2018-09/r/eclipse-ide-java-developers) | ||
| and just install Eclipse PDE from the Eclipse Marketplace. | ||
|
|
||
| 8. Notes about debugging: the `-agentlib:` is for connecting a java debugger agent to the process, and if you wish to debug the server from the start of execution, set `suspend=y` so that the JVM will wait for your debugger prior to starting the server | ||
| 2. Once installed use `File > Open Projects from File System...` and | ||
| point it at `eclipse.jdt.ls` and Eclipse should automatically | ||
| detect the projects and import it properly. | ||
|
|
||
| 3. If, after importing the projects, you see an error on `pom.xml` about Tycho, you can use Quick Fix | ||
| (Ctrl+1) to install the Tycho maven integration. | ||
|
|
||
| 4. At that point, some plug-ins should still be missing in order to build the project. You can either open `org.eclipse.jdt.ls.target/org.eclipse.jdt.ls.tp.target` in the Target Editor (which is the default editor) and click on `Set Target Platform`, or alternatively, open `Preferences > Plug-in Development > Target Platform` and select `Java Language Server Target Definition`). Eclipse will take some time to download all the required dependencies. It should then be able to compile all the projects in the workspace. |
There was a problem hiding this comment.
I'd also like to add instructions for how to develop eclipse.jdt.ls using eclipse.jdt.ls - I found #305 but didn't really manage to extract how it is supposed to work.
Is https://github.com/gorkem/jdt.ls.pde/ still up2date and if so - should adding it to the bundles configuration enable eclipse.jdt.ls to load eclipse.jdt.ls ?
There was a problem hiding this comment.
Using eclipse.jdt.ls to dogfood eclispe.jdt.ls is already supported, please see the contribution guide https://github.com/eclipse/eclipse.jdt.ls/blob/master/CONTRIBUTING.md#a-setting-up-the-jdt-language-server-in-vs-code.
Also i think we can remove the part "Development First Time Setup" from README, because CONTRIBUTING.md has already covered how to setup the develop environment.
There was a problem hiding this comment.
I pushed a fixup that changes the Development First Time Setup section to just have a link to the contributing file.
README.md
Outdated
| 1. Choose a connection type from "Managing connection types" section below, and then set those environment variables in your terminal or specify them as system properties with `-D` prior to continuing | ||
| 1. Chose a value for `-configuration`: this is the path to your platform's configuration directory. For linux, use `./config_linux`. For windows, use `./config_win`. For mac/OS X, use `./config_mac`. | ||
| 2. Change the filename of the jar in `-jar ./plugins/...` to match the version you built or downloaded. | ||
| 3. Choose a value for `-data`: the value for your data directory, should be the directory where your active workspace is, and you wish for the java langserver to add in its default files. Should also be the absolute path to this directory, ie., /home/username/workspace |
There was a problem hiding this comment.
From what I've seen this should be unique per project(?).
eclipse.jdt.ls always ends up creating a jdt.ls-java-project folder inside (instead of project specific ones).
Or is this due to the lsp client not setting some initialization options that it should?
There was a problem hiding this comment.
Yes, it's per workspace. -data parameter is used to specify a local cache directory to store the metadata files (e.g. index files, logs, etc.) generated by Java language server.
Please notice that this parameter is not the user's project root folder. The project root folder you want to import is passed by LSP Initialization options.
There was a problem hiding this comment.
Thanks for the clarification. I rephrased the third point here a bit in the fixup I pushed
README.md
Outdated
| ``` | ||
|
|
||
| 6. Choosing a value for `-configuration`: this is the path to your platform's configuration directory. For linux, use `./config_linux`. For windows, use `./config_win`. For mac/OS X, use `./config_mac`. | ||
| 1. Chose a value for `-configuration`: this is the path to your platform's configuration directory. For linux, use `./config_linux`. For windows, use `./config_win`. For mac/OS X, use `./config_mac`. |
There was a problem hiding this comment.
typos. Chose -> Choose
There was a problem hiding this comment.
Fixed. I rebased and squashed the previous fixup. I hope that's okay.
mfussenegger
force-pushed
the
readme-usage-instruction
branch
from
1facaa6
to
2107fc4
Compare
The README was rather developer focused (and only targeting eclipse users at that) This puts the focus more on end-user usage. The main motivation for this is to enable other editors or plugins to point users to the installation instructions within this repository to focus their own efforts on explaining how to configure the editor/plugin. Signed-off-by: Mathias Fussenegger <f.mathias@zignar.net>
mfussenegger
force-pushed
the
readme-usage-instruction
branch
from
2107fc4
to
9bbf787
Compare
|
@mfussenegger Looks better, thanks for your contribution. |
The README was rather developer focused (and only targeting eclipse
users at that)
This puts the focus more on end-user usage.
The main motivation for this is to enable other editors or plugins to
point users to the installation instructions within this repository to
focus their own efforts on explaining how to configure the
editor/plugin.