Add notes

PaperMC · Mar 9, 2023 · e17949e · e17949e
1 parent 08b84c2
commit e17949e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,9 @@ The files of most interest are
 - settings.gradle.kts
 - gradle.properties
 
+When updating upstream, be sure to keep the dependencies noted in `build.gradle.kts` in sync with upstream.
+It's also a good idea to use the same version of the Gradle wrapper as upstream.
+
 ## Tasks
 
 ```

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,7 +1,11 @@
 plugins {
     java
     `maven-publish`
+
+    // Nothing special about this, just keep it up to date
     id("com.github.johnrengelman.shadow") version "7.1.2" apply false
+
+    // In general, keep this version in sync with upstream. Sometimes a newer version than upstream might work, but an older version is extremely likely to break.
     id("io.papermc.paperweight.patcher") version "1.4.0"
 }
 
@@ -15,9 +19,9 @@ repositories {
 }
 
 dependencies {
-    remapper("net.fabricmc:tiny-remapper:0.8.6:fat")
-    decompiler("net.minecraftforge:forgeflower:2.0.605.1")
-    paperclip("io.papermc:paperclip:3.0.2")
+    remapper("net.fabricmc:tiny-remapper:0.8.6:fat") // Must be kept in sync with upstream
+    decompiler("net.minecraftforge:forgeflower:2.0.605.1") // Must be kept in sync with upstream
+    paperclip("io.papermc:paperclip:3.0.2") // You probably want this to be kept in sync with upstream
 }
 
 allprojects {