init

base to build this game off of

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d1eaec3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Hitler Clicker
+
+Hitler Clicker is a simple game where you have to choose one of 3 teams to click for.
+The team with the most clicks wins, except that the game is endless.
+
+- - -
+
+## Test Environment
+
+There is an included testing environment. Requirements are Docker and PHP.
+Docker is generally not needed, you can replace it with any other DB Server.
+PHP has to have the `pdo_mysql` driver enabled.
+
+```sh
+# start mariadb
+cd ./backend/docker-test-env/
+docker compose up -d
+
+# start api
+cd .. #./backend/
+php -S localhost:8000
+
+# start frontend
+# coming soon...
+```