diff --git a/documentation/projects.adoc b/documentation/projects.adoc index 791006b31..422551829 100644 --- a/documentation/projects.adoc +++ b/documentation/projects.adoc @@ -1,11 +1,11 @@ :toc: toc::[] -= Project import += Repositories -The `devonfw-ide` supports to automatically check out and import required projects into your IDE during link:setup.asciidoc[setup]. -To configure this you put a `.properties` file for each desired project into the `projects` sub-folder in your link:settings.asciidoc[settings]. -Each `.properties` file describes one "project" which you would like to check out and (potentially) import: +IDEasy supports to automatically clone and import required git repositories into your IDE during link:setup.asciidoc[setup]. +To configure this you put a `.properties` file for each desired repository into the `repositories` sub-folder in your link:settings.asciidoc[settings]. +Each `.properties` file describes one (git) "repository" which you would like to clone and (potentially) import: [source,properties] ---- @@ -16,7 +16,7 @@ git_url=http://github.com/someorg/someproject git_branch=develop build_path=. build_cmd=mvn -DskipTests=true -Darchetype.test.skip=true clean install -eclipse=import +import=eclipse,intellij active=true ---- @@ -38,13 +38,10 @@ Git default branch is default. For a regular project use `.` to build top-level project. |`build_cmd` |e.g. `mvn -D skip Tests=true -Darchetype.test.skip=true clean install` -|(optional) The _devonfw_ command to invoke to build the project after clone or pull. +|(optional) The IDEasy command to invoke (excluding the `ide` CLI command itself) to build the project after clone or pull. If omitted no build is triggered. -|`eclipse`|e.g. `import`|(optional) Desired action for eclipse IDE. -If you put `import` here all modules (eclipse projects) in the current project will be imported into eclipse. -If you leave this out or put any other value for this parameter, no change in eclipse is done. +|`import`|e.g. `intellij`|(optional) IDEs where to automatically import the project. +Currently only maven projects are supported. |`active`|`true`|(optional) If set to `false` the project is skipped during the link:setup.asciidoc[setup]. |=== - -Please note that the `.properties` file is parsed via shell and not via java. So be careful with "advanced" features `.properties` files normally support.