|
1 | 1 | <img width="1024" height="241" alt="remora" src="https://github.com/user-attachments/assets/7a38185d-6ece-44c0-adf2-326a3e2f503b" /> |
2 | 2 |
|
3 | | -# Remora - o7studios Gradle helper plugin |
| 3 | +# Remora |
4 | 4 |
|
5 | | -Remora is a Gradle plugin made for o7studios Gradle projects. It includes |
6 | | -automatic shipping of libraries like *lombok*, publishing to Sonatype repositories |
7 | | -and compiler configurations. |
| 5 | +**o7studios helper plugin for Gradle projects** |
8 | 6 |
|
9 | | -## Configuration |
| 7 | +- Adds BuildConstants, Lombok & MavenCentral-Publishing |
| 8 | +- Example configuration [here](https://github.com/o7studios/agones-java-sdk/blob/main/build.gradle.kts) |
10 | 9 |
|
11 | | -Configure your Gradle module by doing the following: |
| 10 | +## Development |
12 | 11 |
|
13 | | -```kotlin |
14 | | -// build.gradle.kts |
| 12 | +Full development setup available as [Development Container](https://containers.dev/). |
| 13 | +Please use it for being able to tell "It works on my machine". |
15 | 14 |
|
16 | | -plugins { |
17 | | - id("studio.o7.remora") |
18 | | -} |
| 15 | +**Docker is required to be installed on your machine!** |
19 | 16 |
|
20 | | -remora { |
21 | | - groupId = "studio.o7" |
22 | | - artifactId = "example-project" |
23 | | -} |
24 | | -``` |
| 17 | +### IntelliJ IDEA |
25 | 18 |
|
| 19 | +- Open IntelliJ (Welcome screen) |
| 20 | +- Navigate to `Remote Development` - `Dev Containers` |
| 21 | +- Press `New Dev Container` |
| 22 | +- Select `From VCS Project` |
| 23 | +- Select and connect with `Docker` |
| 24 | +- Select `IntelliJ IDEA` |
| 25 | +- Enter `Git Repository`: `https://github.com/o7studios/cheetah` |
| 26 | +- Select `Detection for devcontainer.json file` `Automatic` |
| 27 | +- Press `Build Container and Continue` |
| 28 | + |
| 29 | +### Development Container Issues |
| 30 | + |
| 31 | +If you encounter an issue with setting up a development container, please |
| 32 | +try to rebuild it first before opening a GitHub Issue. It's not uncommon |
| 33 | +that some issues may fix themselves after a fresh container rebuild. |
0 commit comments