diff options
author | Kristóf Marussy <kristof@marussy.com> | 2021-10-02 19:38:47 +0200 |
---|---|---|
committer | Kristóf Marussy <kristof@marussy.com> | 2021-10-02 19:38:47 +0200 |
commit | 41c789dc9804e648dfd86c0d1db7ec98a5c2754d (patch) | |
tree | 10e313a30f1287f02096572e4d65758a9f92e3cd | |
parent | build: fix Eclipse project generation instructions (diff) | |
download | refinery-41c789dc9804e648dfd86c0d1db7ec98a5c2754d.tar.gz refinery-41c789dc9804e648dfd86c0d1db7ec98a5c2754d.tar.zst refinery-41c789dc9804e648dfd86c0d1db7ec98a5c2754d.zip |
docs: improve README formatting
-rw-r--r-- | README.md | 9 |
1 files changed, 5 insertions, 4 deletions
@@ -28,12 +28,13 @@ | |||
28 | 28 | ||
29 | 7. Clone the project Git repository but do not import it into Eclipse yet. | 29 | 7. Clone the project Git repository but do not import it into Eclipse yet. |
30 | 30 | ||
31 | 8. Open a new terminal an run `./gradlew generateXtext eclipseJdt` (`.\gradlew generateXtext eclipseJdt` on Windows) in the cloned repository. This should complete without any compilation errors. If you get any errors about the JVM version, check whether the `JAVA_HOME` environment variable is set to the location of JDK. You can query the variable with `echo $JAVA_HOME` on Linux and `echo $Env:JAVA_HOME` in PowerShell on Windows. To set it, use `export JAVA_HOME=/java/path/here` or `$Env:JAVA_HOME="C:\java\path\here"`, respectively. | 31 | 8. Open a new terminal an run `./gradlew generateXtext eclipseJdt` (`.\gradlew generateXtext eclipseJdt` on Windows) in the cloned repository. |
32 | * This should complete without any compilation errors. | ||
33 | * If you get any errors about the JVM version, check whether the `JAVA_HOME` environment variable is set to the location of JDK. You can query the variable with `echo $JAVA_HOME` on Linux and `echo $Env:JAVA_HOME` in PowerShell on Windows. To set it, use `export JAVA_HOME=/java/path/here` or `$Env:JAVA_HOME="C:\java\path\here"`, respectively. | ||
32 | 34 | ||
33 | 9. Select _File > Import... > Gradle > Existing Gradle Project_ and import the cloned repository in Eclipse. | 35 | 9. 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_. | 36 | * 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. | 37 | * If you have previously imported the project into Eclipse, this step will likely fail. In that case, you should remove the projects from Eclipse, run `git clean -fxd` in the repository, and start over from step 8. |
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 | ||
38 | ### With IntelliJ IDEA | 39 | ### With IntelliJ IDEA |
39 | 40 | ||