diff --git a/README.md b/README.md index 6d31396446..d9e6350f92 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ everyone mod Minecraft freely and openly, while also being able to innovate and To see the current version being targetted, check the branch name! +## Usage +To use yarn-deobfuscated Minecraft for Minecraft modding or as a dependency in a Java project, you can use [loom](https://github.com/fabricmc/fabric-loom) Gradle plugin. See [fabric wiki tutorial](https://fabricmc.net/wiki/tutorial:setup) for more information. + +To obtain a deobfuscated Minecraft jar, [`./gradlew mapNamedJar`](#mapNamedJar) will generate a jar named like `-named.jar`, which can be sent to a decompiler for deobfuscated code. + ## Contributing Please remember that copying and pasting mappings from alternate projects under more restrictive licenses (such as MCP) is **completely forbidden** without explicit permission from the