Skip to content

Commit

Permalink
[DOC] update development environment docs
Browse files Browse the repository at this point in the history
  • Loading branch information
m273d15 committed Nov 19, 2019
1 parent a40f732 commit 6e4b6ba
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions docs/contribute/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,9 @@ If you want to execute the STF tests it is recommended to use eclipse. Otherwise
## Common
* You have to [clone](https://help.github.com/articles/cloning-a-repository/) the Saros repository with [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
* You need a **Java 8 JDK**.
* You need an **Eclipse 4.6** installation which is used for dependency resolution. You can either install a [minimal Eclipse](http://www.eclipse.org/downloads/packages/release/neon/3/eclipse-ide-java-developers) or [Eclipse for Eclipse Committers](http://www.eclipse.org/downloads/packages/release/neon/3/eclipse-ide-eclipse-committers) if you also want to develop with eclipse.
* Install **GEF Legacy** into Eclipse using the 'GEF-Legacy Releases' update site given [here](https://projects.eclipse.org/projects/tools.gef/downloads)
* You need an **Intellij IDEA** installation which is used for dependency resolution. Install a current version of [**IntelliJ IDEA**](https://www.jetbrains.com/idea/download/#section=linux) (we have only tested Saros/I for IntelliJ releases 2017.X and later)

Set the **system-wide environment variable `ECLIPSE_HOME`** to the eclipse installation dir that contains the directory `plugins`.<br/>
* *Optional:* You can install an **Intellij IDEA** installation which is used for dependency resolution. Install a current version of [**IntelliJ IDEA**](https://www.jetbrains.com/idea/download/#section=linux) (we have only tested Saros/I for IntelliJ releases 2017.X and later).<br/>
Set the **system-wide environment variable `INTELLIJ_HOME`** to the intellij installation dir that contains the directory `lib`.

If the `ECLIPSE_HOME` variable is not set or not global the correponding eclipse specific dependencies cannot be found during build.<br/>
If the `INTELLIJ_HOME` variable is not set or not global the intellij-gradle plugin will download a version of IntelliJ which is
defined in the gradle build description.

## Develop with Eclipse
If you develop on Eclipse you should have already installed the Eclipse version for "Eclipse Committers".

Expand Down Expand Up @@ -63,7 +55,6 @@ This is necessary in order to allow IntelliJ to execute all build and test actio

* Click on `Open`
* Select the repository root as project root and click `OK`
* Open the gradle task view and execute the task `prepareIntellij`

## Develop without an IDE
If you prefer to develop with a text editor (like Vim or Emacs) you can build and test
Expand All @@ -76,8 +67,7 @@ The following tasks are used to build and test the different Saros components:
* `sarosIntellij` - Triggers the build and test of the Saros IntelliJ Plugin
* `sarosServer` - Triggers the build and test of the Saros Server
* `prepareEclipse` - Executes all tasks which are required before developing in Eclipse
* `prepareIntellij` - Executes all tasks which are required before developing in IntelliJ
* `runIde` - Starts a IntelliJ IDE containing the Saros Plugin. The IDE version depends on the value of `INTELLIJ_HOME`.
* `runIde` - Starts a IntelliJ IDE containing the Saros Plugin. The IDE version depends on the value of `INTELLIJ_HOME` or the `intellijVersion` specified in the build file of the IntelliJ package.

In order to build the whole project without using existing build artifacts simply call `./gradlew cleanAll sarosEclipse sarosIntellij sarosServer`.

Expand Down

0 comments on commit 6e4b6ba

Please sign in to comment.