diff --git a/README.md b/README.md index 56741b0d4..8261f7dea 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@

Flywheel

A modern engine for modded Minecraft.
Jenkins -Discord -Curseforge Downloads +Discord +Curseforge Downloads
- +d ## About The goal of this project is to provide tools for mod developers so they no longer have to worry about performance, or limitations of Minecraft's archaic rendering engine. That said, this is primarily an outlet for me to have fun with graphics programming. @@ -26,3 +26,23 @@ To accomodate the developer and leave more in the hands of the engine, Flywheel - Compute shader particles - Deferred rendering - Different renderers for differently aged hardware + + +### Getting Started (For Developers) + +Add the following repo to your `build.gradle`: +```groovy +repositories { + maven { + name "tterrag maven" + url "https://maven.tterrag.com/" + } +} +``` + +Then add Flywheel as a dependency: +```groovy +dependencies { + compile fg.deobf("com.jozufozu.flywheel:Flywheel:1.16-0.0.2.6") +} +```