Skip to content

Commit 41fd697

Browse files
committed
docs: add info about Maven Snapshots
1 parent b37f6ac commit 41fd697

1 file changed

Lines changed: 43 additions & 6 deletions

File tree

README.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,14 @@ TM4E is an [official Eclipse.org project](https://projects.eclipse.org/projects/
1111

1212
## 📥 Install
1313

14-
### in Eclipse IDE or RCP applications
14+
### 1) in Eclipse IDE or RCP applications
1515

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

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

21-
### as a Java API with Maven
22-
23-
[more information coming soon]
24-
25-
### Eclipse IDE compatibility
21+
#### Eclipse IDE compatibility
2622

2723
TM4E version | Min. Eclipse version
2824
-------------|--------------------
@@ -35,6 +31,47 @@ TM4E version | Min. Eclipse version
3531
[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))
3632

3733

34+
### 2) as a Java API with Maven
35+
36+
**Snapshot** binaries of `org.eclipse.tm4e.core` are available at https://repo.eclipse.org/content/repositories/tm4e-snapshots/org/eclipse/org.eclipse.tm4e.core/.
37+
You need to add the following repository configuration to your Maven `settings.xml`:
38+
39+
```xml
40+
<?xml version="1.0" encoding="UTF-8" ?>
41+
<settings>
42+
<profiles>
43+
<profile>
44+
<repositories>
45+
<repository>
46+
<id>tm4e-snapshots</id>
47+
<name>tm4e-snapshots</name>
48+
<url>https://repo.eclipse.org/content/repositories/tm4e-snapshots/</url>
49+
<releases><enabled>false</enabled></releases>
50+
<snapshots><enabled>true</enabled></snapshots>
51+
</repository>
52+
</repositories>
53+
</profile>
54+
</profiles>
55+
<activeProfiles>
56+
<activeProfile>tm4e-snapshots</activeProfile>
57+
</activeProfiles>
58+
</settings>
59+
```
60+
61+
Then you can reference the dependency in your pom.xml like so:
62+
```xml
63+
<dependencies>
64+
<dependency>
65+
<groupId>org.eclipse</groupId>
66+
<artifactId>org.eclipse.tm4e.core</artifactId>
67+
<version>[VERSION]-SNAPSHOT</version>
68+
</dependency>
69+
</dependencies>
70+
```
71+
72+
[more information coming ...]
73+
74+
3875
## ⌨️ Code
3976

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

0 commit comments

Comments
 (0)