summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDmitri Morozov <snoopdesigns@gmail.com>2024-02-02 19:47:51 +0100
committerue86388 <dmitrii.morozov@sbb.ch>2024-02-02 19:47:51 +0100
commit684552e8cebfa0d80b9ceb014d6094327c6ad0a6 (patch)
tree398a3b4578a52086571e9b972439c80f708a6520
parente3935fe4b6ecfbe161001fc95d295f53e8520c52 (diff)
Readme actualized
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8f058d8..f04b013 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# endless-game \ No newline at end of file
+# endless-game
+
+## A small LibGDX based game written in Java
+A simple experiment in game development. Implemented using plain Java and [LibGDX](https://github.com/libgdx/libgdx) graphics library.
+
+## Requirements
+1. Java >= 17
+2. Apache Maven
+
+## Running
+Build and execute using Gradle wrapper:
+```
+./gradlew clean build run
+``` \ No newline at end of file