Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 1.45 KB

README.md

File metadata and controls

39 lines (25 loc) · 1.45 KB

Tetris Library for Kotlin 🕹️

CI Tests

This library gives all the facilities for implementing a Tetris game.

Summary

Getting Started 🔍

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.

Dependencies:

  • kotlin (1.5.10) and the Java JDK (17)
  • maven

Compiling and testing the project

You can install the dependencies, compile the project and run the tests by executing the following command:

mvn package

Although it is recommended to install a java IDE (e.g. IntelliJ IDEA) to run the tests and view the overall project.

Examples 🖥️

For seeing a very simple example that shows some of the methods and classes that this library offers, you can checkout this gist

License 📖

The project is licensed under the GNU General Public License v3.0. See the LICENSE file for more information.

Contributing 🧑‍🤝‍🧑

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.