Add README.md

Mediang · May 7, 2022 · 7e9295e · 7e9295e
1 parent 2f23a37
commit 7e9295e
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# Bromine
+
+## Features
+
+- Asynchronous entity tracker
+
+## Downloads
+
+The latest jar file can be found [here](https://github.com/Mediang/Bromine/releases/tag/release).
+The direct download link is [here](https://github.com/Mediang/Bromine/releases/download/release/Bromine-paperclip-1.18.2-R0.1-SNAPSHOT-reobf.jar).
+
+## Building
+
+You need to run these commands in a linux environment, or WSL.
+At least JDK 7 is required to be installed.
+
+```shell
+./gradlew applyPatches
+./gradlew createReobfPaperclipJar
+```
+
+The execution time may vary depending on your hardware.
+The reobfuscated paperclip jar file can be found in `build/libs`.
+
+## License
+
+Patches are licensed under [GPL-3.0](PATCH-LICENSE), everything else under MIT.