Skip to content

Commit 03531eb

Browse files
authored
Readme tweaks (#11)
* Pom tweaks, removed goals from gmavenplus which cuase problems. Goals are only needed when combining java and groovy <goal>generateStubs</goal> <goal>generateTestStubs</goal> <goal>removeStubs</goal> <goal>removeTestStubs</goal> * Updated readme with info on how to use DevStack as a dependency
1 parent 036e831 commit 03531eb

1 file changed

Lines changed: 56 additions & 1 deletion

File tree

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,59 @@
2020
* This should normally be set to your external ip, check for example: https://whatismyipaddress.com
2121

2222
5. Go to Environments/Terraform and run terraform apply
23-
* Note the "Hosts-record" output, this needs to be added to your /etc/hosts
23+
* Note the "Hosts-record" output, this needs to be added to your /etc/hosts
24+
25+
26+
## Using DevStack in your project
27+
28+
A note on versions, DevStack is cross-compiled for both Groovy 3 and 2.5, these editions are also available in a standalone edition with shaded dependencies.
29+
30+
The standalone edition should alleviate dependency issues but is also larger
31+
32+
Examples:
33+
* com.eficode:devstack:2.0.0-SNAPSHOT-groovy-2.5
34+
* DevStack version 2.0.0, compiled for groovy 2.5
35+
* devstack:2.0.0-SNAPSHOT-groovy-3.0:jar:standalone
36+
* DevStack version 2.0.0, compiled for groovy 3, standalone edition.
37+
38+
To find the latest version, check the "packages" branch: https://github.com/eficode/devStack/tree/packages/repository/com/eficode/devstack
39+
40+
41+
### Maven install
42+
43+
```bash
44+
45+
mvn dependency:get -Dartifact=com.eficode:devstack:2.0.0-SNAPSHOT-groovy-2.5 -DremoteRepositories=https://github.com/eficode/DevStack/raw/packages/repository/
46+
47+
48+
mvn dependency:get -Dartifact=com.eficode:devstack:2.0.0-SNAPSHOT-groovy-2.5:jar:standalone -DremoteRepositories=https://github.com/eficode/DevStack/raw/packages/repository/
49+
50+
```
51+
52+
53+
### POM dependency
54+
55+
```xml
56+
..
57+
....
58+
<dependencies>
59+
<dependency>
60+
<groupId>com.eficode</groupId>
61+
<artifactId>devstack</artifactId>
62+
<version>2.0.0-SNAPSHOT-groovy-3.0</version>
63+
<!--Optional standalone classifier-->
64+
<!--classifier>standalone</classifier-->
65+
</dependency>
66+
</dependencies>
67+
68+
..
69+
....
70+
<repositories>
71+
<repository>
72+
<id>eficode-github-DevStack</id>
73+
<url>https://github.com/eficode/DevStack/raw/packages/repository/</url>
74+
</repository>
75+
</repositories>
76+
..
77+
....
78+
```

0 commit comments

Comments
 (0)