Add readme.md

This commit is contained in:
Julius de Jeu 2018-11-06 21:53:59 +00:00
parent b54f491b9f
commit a1d79e0475

10
README.md Normal file
View file

@ -0,0 +1,10 @@
# OttoBot
This is the discord bot used by the CSE1821 server, it is used for music,
fun and role assignment at this moment.
## Build instructions
1. run `gradlew copyDependencies` to copy all dependencies into the folder `libs`
2. run `gradlew jar` to create the final jar in `build/libs/UnityBot.jar`
3. copy all files into a directory and start the bot using `java -cp '*' nl.voidcorp.dbot.UnityBotKt <bot-token>`
4. you now have a functionalish bot! Have fun!