From 59930bea383c25e00f92b79750a0e8b2e5fa5050 Mon Sep 17 00:00:00 2001
From: Linnea Gräf <nea@nea.moe>
Date: Wed, 6 Mar 2024 02:41:02 +0100
Subject: Add installation tutorial

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'README.md')

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.
-- 
cgit