Skip to content
Snippets Groups Projects
Commit b64af077 authored by Juergen Haug's avatar Juergen Haug
Browse files

updated README

parent cf484ff7
No related branches found
No related tags found
No related merge requests found
# eTrice
[![](https://gitlab.eclipse.org/eclipse/etrice/etrice/badges/master/pipeline.svg?ignore_skipped=true)](https://gitlab.eclipse.org/eclipse/etrice/etrice/-/commits/master)
The project info and wiki is located here: [eTrice wiki](https://gitlab.eclipse.org/groups/eclipse/etrice/-/wikis/home)
# eTrice - Real-Time Modeling Tools
* [Home](https://eclipse.dev/etrice)
* [Documentation](https://eclipse.dev/etrice/documentation/release)
* [Downloads](https://eclipse.dev/etrice/downloads/#getting-started)
* [Issues](https://gitlab.eclipse.org/eclipse/etrice/etrice/-/issues)
* [Forum](https://www.eclipse.org/forums/index.php?t=thread&frm_id=199)
* [Developer Wiki](https://gitlab.eclipse.org/groups/eclipse/etrice/-/wikis/home)
## Development
......@@ -8,35 +15,32 @@ The project info and wiki is located here: [eTrice wiki](https://gitlab.eclipse.
You can automate the workspace setup with the Oomph setup file [team/ETrice.setup](team/ETrice.setup), see [instructions](https://gitlab.eclipse.org/groups/eclipse/etrice/-/wikis/Development/GettingStartedWithEtrice).
Alternatively install from the Eclipse update site:
* Xtext
* Graphiti
* Ecore
* CDT
and from the Eclipse Orbit update site `https://download.eclipse.org/tools/orbit/downloads/drops/R20230531010532`:
* org.apache.commons.io
* com.atlassian.commonmark(-*)
If you want to reproduce the CI build, see [releng/org.eclipse.etrice.parent/pom.xml](releng/org.eclipse.etrice.parent/pom.xml).
### Build
### Headless Build
The Gradle build requires [JDK 11](https://adoptium.net/de/temurin/releases/?version=11). It can be placed on PATH or configured in the [gradle.properties](gradle.properties) file.
The Tycho/Maven for the Eclipse P2 plugins and plugin tests
```
mvn verify
./gradlew assemble
```
The Gradle build for the headless generators and generator tests
The Tycho/Maven build for the Eclipse P2 plugins is activated via the Gradle property `-Pmaven`. In addition, it requires JAVA_HOME to be set.
```
.\gradlew build
export JAVA_HOME="path/to/jdk"
./gradlew assemble -Pmaven
```
### Headless Test
In order to build eTrice C/C++ projects and tests with Gradle, a GCC toolchain must be available on the `PATH`.
For Windows the latest release of MinGW-w64 with UCRT runtime and POSIX threads is recommended, which can be downloaded from [WinLibs](https://winlibs.com/).
```
./gradlew build
```
## Publish
Release builds (commit has version tag) are published to Maven [etrice-releases](https://repo.eclipse.org/content/repositories/etrice-releases) repository and P2 site [download.eclipse.org/etrice](https://download.eclipse.org/etrice).
......@@ -44,5 +48,4 @@ Release builds (commit has version tag) are published to Maven [etrice-releases]
Master builds without tag are published to Maven [etrice-snapshots](https://repo.eclipse.org/content/repositories/etrice-snapshots) repository with version `<last version>-SNAPSHOT` and the P2 site [download.eclipse.org/etrice/nightly](https://download.eclipse.org/etrice/nightly).
All other builds are published to Maven [etrice-snapshots](https://repo.eclipse.org/content/repositories/etrice-snapshots) repository. The version is set to `<last version>-<branch>-SNAPSHOT`, where special chars are replaced with `-`.
In any case, you can see the current version in the console output via `.\gradlew`.
In any case, you can see the current version in the console output via `./gradlew`.
org.gradle.jvmargs=-Xms256m -Xmx1g -XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError
\ No newline at end of file
# Note: backslashes must be replaced with forward slashes
org.gradle.jvmargs=-Xms256m -Xmx1g -XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError
# org.gradle.java.home=path/to/jdk
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment