diff --git a/README.md b/README.md new file mode 100644 index 0000000..03c19c2 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# drawing Kotlin Tetrux + +A very simple clone of the famous [Tetris Game](https://tetris.com/) written in Kotlin for this week's assignment + +The game utilises the JavaFX framework to display the game and user interface. Additionally, a custom written logger + sound manager is being used to make development easier. +
+ +
+ +## 🐘 Features + +* Full fledged Tetris clone +* Custom logger + sound manager +* Awesome Music +* Modifyable keybinds + +## 🎉 Upcoming Features + +* Auto-Saving Keybinds +* Leaderboard + +## :books: Libraries + +* [Kotlin language](https://kotlinlang.org/) +* [JavaFX framework](https://openjfx.io/) + +## :package: Download + +The Game is packaged as an macOS app-image found in the releases tab.
+Compile it yourself by running `mvn clean install`. The executable is found in `target/installer`. + +## :hammer: Installation + +1. Clone the repository (preferably into IntelliJ IDEA) +2. Open the project and let maven do its thing +3. Run + enjoy! + +## ⚠️ Disclaimer + +* This game is definitely not a clone of the original Tetris game. +* Please don't judge me for my code (I try my best) and don't use it as a reference. \ No newline at end of file