diff options
-rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
@@ -0,0 +1,40 @@ | |||
1 | |||
2 | # How to contribute | ||
3 | |||
4 | ## With Eclipse IDE | ||
5 | |||
6 | 1. Download and install a _Java 11_ compatible JDK. For Windows, prefer OpenJDK builds from [Adoptium](https://adoptium.net/). | ||
7 | |||
8 | 2. Download and extract the [Eclipse Modeling Tools 2021-09](https://www.eclipse.org/downloads/packages/release/2021-09/r/eclipse-modeling-tools) package. | ||
9 | |||
10 | 3. Launch Eclipse and create a new workspace. | ||
11 | |||
12 | 4. Switch to the _Java_ perspective and close the _Modeling_ perspective. | ||
13 | |||
14 | 5. Open _Help > Install New Software..._ and install the following software from the _2021-09_ update site: | ||
15 | * _Modeling > Ecore Diagram Editor (SDK)_ | ||
16 | * _Modeling > Xtext Complete SDK_ | ||
17 | * _Programming Languages > Xtend IDE_ | ||
18 | |||
19 | 6. Open _Help > Eclipse Marketplace_ and install _Buildship Gradle Integration_. | ||
20 | |||
21 | 7. Open _Window > Preferences_ and set the following preferences: | ||
22 | * _General > Workspace > Text file encoding_ should be _UTF-8_. | ||
23 | * _General > Workspace > New text file line delimiter_ should be _Unix_. | ||
24 | * Add the JDK 11 to _Java > Installed JREs_. | ||
25 | * Make sure JDK 11 is selected for _JavaSE-11_ at _Java > Installed JREs > Execution Environments_. | ||
26 | * Set _Gradle > Java home_ to the `JAVA_HOME` directory (the directory which contains the `bin` directory) of JDK 11. | ||
27 | Buildship will show a yellow warning sign, which can be safely ignored. | ||
28 | |||
29 | 8. Clone the project Git repository but do not import it into Eclipse. | ||
30 | |||
31 | 9. Open a new terminal an run `./gradlew build` (`.\gradlew build` on Windows) in the cloned repository. This should complete without any compilation error. | ||
32 | |||
33 | 10. Select _File > Import... > Gradle > Existing Gradle Project_ and import the cloned repository in Eclipse. | ||
34 | Make sure to select the root of the repository (containing this file) as the _Project root directory_ and that the _Gradle distribution_ is _Gradle wrapper_. | ||
35 | If you have previously imported the project into Eclipse, this step will likely fail. | ||
36 | In that case, you can remove the projects from Eclipse, run `git clean -fxd` in the repository, and start over from step 9. | ||
37 | |||
38 | ## With IntelliJ IDEA | ||
39 | |||
40 | It is possible to import the project into IntelliJ IDEA, but it gives no editing help for Xtext (`*.xtext`), MWE2 (`*.mwe2`), and Xtend (`*.xtend`) and Ecore class diagrams (`*.aird`, `*.ecore`, `*.genmodel`). | ||