Use archiveClassifier instead of classifier

[LightOverlay.git] / README.md

diff --git a/README.md b/README.md
index 4a9d71432ea48124dd276e28aa8715a4ba4d570b..e2acc10a2d463b9eeabb424e033bd3f315ddd62a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,12 @@
-LightOverlay-Forge
+# LightOverlay
+
+Fabric and Forge are split into modules, and we merge it afterwards
+
+# Running
+Fabric: `gradlew :fabric:runClient`<br>
+Forge: `gradlew :forge:runClient`
+
+Or use the run configs if you are using IntelliJ IDEA.
+
+# Compiling
+Run `gradlew build`, and the merged jar will be in `fabric|forge/build/libs/`.
\ No newline at end of file