Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mnemotechnician committed Dec 31, 2021
1 parent 56e7c2b commit c042435
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Mindustry Kotlin Ui Lib
An utility library for mindustry mods.

Provides a set of inline extension functions that allow you to build mindustry ui in an idiomatic & optimized way.
Also provides some utility extension functions that arc lacks.

May not be compatible with other (non-mindustry) arc projects.
May not be compatible with other (non-mindustry) arc projects.

***Note: this library will only work with mods written in kotlin!***

# Adding this dependency
In your `build.gradle` file:
* add `maven { url("https://jitpack.io") }` to the `repositories {}` block
(it should already be here if you're using the official mod template)
* add `implementation "com.github.mnemotechnician:MKUI:TAG"` (replace `TAG` with the the latest tag in this repo) to the `dependencies {}` block

## in case you're using kotlin dls:
Ignore this paragraph if you're using the official kotlin mod template
* use `maven("https://jitpack.io")` in the first step
* use `implementation("com.github.mnemotechnician:MKUI:TAG")` in the second step

0 comments on commit c042435

Please sign in to comment.