Skip to content

Commit

Permalink
docs: add info about Maven Snapshots
Browse files Browse the repository at this point in the history
  • Loading branch information
sebthom committed Aug 14, 2024
1 parent b37f6ac commit 8116939
Showing 1 changed file with 43 additions and 6 deletions.
49 changes: 43 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,14 @@ TM4E is an [official Eclipse.org project](https://projects.eclipse.org/projects/

## 📥 Install

### in Eclipse IDE or RCP applications
### 1) in Eclipse IDE or RCP applications

You can install TM4E from the update site [https://download.eclipse.org/tm4e/releases/latest/](https://download.eclipse.org/tm4e/releases/latest/).
TM4E is usually installed together with its consumers, so end-user should usually not need to directly install it.

The latest snapshot build can be installed from the update site [https://download.eclipse.org/tm4e/snapshots/](https://download.eclipse.org/tm4e/snapshots/).

### as a Java API with Maven

[more information coming soon]

### Eclipse IDE compatibility
#### Eclipse IDE compatibility

TM4E version | Min. Eclipse version
-------------|--------------------
Expand All @@ -35,6 +31,47 @@ TM4E version | Min. Eclipse version
[0.6.0](https://download.eclipse.org/tm4e/releases/0.6.0/)+ | [2022-03](https://projects.eclipse.org/releases/2022-03) ([4.23](https://projects.eclipse.org/projects/eclipse/releases/4.23.0))


### 2) as a Java API with Maven

**Snapshot** binaries of `org.eclipse.tm4e.core` are available via at https://repo.eclipse.org/content/repositories/tm4e-snapshots/org/eclipse/org.eclipse.tm4e.core/.
You need to add the following repository configuration to your Maven `settings.xml`:

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<settings>
<profiles>
<profile>
<repositories>
<repository>
<id>tm4e-snapshots</id>
<name>tm4e-snapshots</name>
<url>https://repo.eclipse.org/content/repositories/tm4e-snapshots/</url>
<releases><enabled>false</enabled></releases>
<snapshots><enabled>true</enabled></snapshots>
</repository>
</repositories>
</profile>
</profiles>
<activeProfiles>
<activeProfile>tm4e-snapshots</activeProfile>
</activeProfiles>
</settings>
```

Then you can reference the dependency in your pom.xml like so:
```xml
<dependencies>
<dependency>
<groupId>org.eclipse</groupId>
<artifactId>org.eclipse.tm4e.core</artifactId>
<version>[VERSION]-SNAPSHOT</version>
</dependency>
</dependencies>
```

[more information coming ...]


## ⌨️ Code

<a href="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/redirect.html"><img src="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/cloneToEclipseBadge.png" alt="Clone to Eclipse IDE"/></a>
Expand Down

0 comments on commit 8116939

Please sign in to comment.