initial commit

1 files changed, 36 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92d962c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Frogartha Open Source
+
+A chat room game, written in Java and LibGDX. This project uses Gradle to manage dependencies.
+
+## Building from sources
+
+To compile this project you will need [JDK 11](https://adoptium.net). Copy the repository and open it via the terminal
+and do what you need:
+
+### Desktop (Windows/macOS/Linux)
+
+- `./gradlew lwjgl3:run`: starts the application.
+- `./gradlew lwjgl3:dist`: builds application's runnable jar, which can be found at `lwjgl3/build/libs`.
+
+### HTML
+
+- `./gradlew html:dist`: compiles GWT sources. The compiled application can be found at `html/build/dist`: you can use
+  any HTTP server to deploy it.
+- `./gradlew html:superDev`: compiles GWT sources and runs the application in SuperDev mode. It will be available
+  at [localhost:8080/html](http://localhost:8080/html). Use only during development.
+
+### Server
+
+- `./gradlew server:run`: runs the server application.
+
+## Downloads
+
+| [![itch.io](https://static.itch.io/images/badge.svg)](https://ilotterytea.itch.io/frogartha) |
+|----------------------------------------------------------------------------------------------|
+
+## License
+
+This project is under the Mozilla Public License
+2.0! [Read on LICENSE](https://github.com/ilotterytea/frogartha/blob/master/LICENSE).<br>
+Project Assets under
+the [Creative Commons Attribution v4.0 International](https://creativecommons.org/licenses/by/4.0/)!