From ba526bb38595303b4ec33719a75a8622660b537d Mon Sep 17 00:00:00 2001 From: zml Date: Sun, 16 May 2021 22:13:19 -0700 Subject: [PATCH] update readme for extra release information --- README.MD => README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) rename README.MD => README.md (78%) diff --git a/README.MD b/README.md similarity index 78% rename from README.MD rename to README.md index 8c22008..2fc7474 100644 --- a/README.MD +++ b/README.md @@ -1,8 +1,7 @@ ![VanillaGradle Logo](docs/logo.png?raw=true) **VanillaGradle** is a toolchain for *Minecraft: Java Edition* that provides a workspace to interact with the game using official mappings provided -by Mojang Studios. This plugin requires at least Gradle 6.7 to run, though it is only actively tested against the latest release of every major Gradle -series supported (currently 6.x and 7.x). +by Mojang Studios. This plugin requires at least Gradle 6.7 and Java 8 to run, though it is only actively tested against the latest release of every major Gradle series supported (currently 6.x and 7.x). ### Documentation @@ -35,7 +34,7 @@ minecraft { } ``` -Within IntelliJ IDEA, this will generate run configurations named `runClient` and `runServer` +Within IntelliJ IDEA and Eclipse, this will generate run configurations named `runClient` and `runServer` To have browsable sources in-IDE, run `./gradlew decompile` @@ -50,6 +49,10 @@ your system you can instead run the supplied Gradle wrapper `gradlew`)* ### Version History +**Compatibility:** We use [Semantic Versioning](https://semver.org/) for the user-visible API in VanillaGradle. This applies to every public class +outside of the `org.spongepowered.gradle.vanilla.internal` package. The contents of the `internal` package are considered implementation details +and are subject to change at any time. + @@ -61,7 +64,7 @@ your system you can instead run the supplied Gradle wrapper `gradlew`)* - +
0.2Map 2021May 2021
  • Run configurations are generated for Eclipse