aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLinnea Gräf <nea@nea.moe>2024-03-06 02:41:02 +0100
committerLinnea Gräf <nea@nea.moe>2024-03-06 02:41:02 +0100
commit59930bea383c25e00f92b79750a0e8b2e5fa5050 (patch)
tree9e380dca3f0e2b22551846bc961f66427a2f4c3e /README.md
parenta04c668c0b52b35537deae44214bc814e30a751b (diff)
downloadNeaCoderPack-59930bea383c25e00f92b79750a0e8b2e5fa5050.tar.gz
NeaCoderPack-59930bea383c25e00f92b79750a0e8b2e5fa5050.tar.bz2
NeaCoderPack-59930bea383c25e00f92b79750a0e8b2e5fa5050.zip
Add installation tutorial
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3b4c608..609c080 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,20 @@
+# Nea Coder Pack
+> Mapping extensions to 1.8.9 MCP
+
+Currently, requires zwirn installed in the local maven repo:
+
+```sh
+git clone https://github.com/nea89o/zwirn
+cd zwirn
+./gradlew publishToMavenLocal
+```
+
+## Editing workflow
- `./gradlew unpackMappings`
- `./gradlew launchEnigma`
- `./gradlew generateDiffTiny`
-- `./gradlew generateMappingPatches` \ No newline at end of file
+- `./gradlew generateMappingPatches`
+
+Usage in other projects is not possible right now, but a gradle plugin will eventually follow.