diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48a7011
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Gytebot
+
+This project was developed as a school project. The name abbreviates from "Gyte" which stands for the school GYmnasium TEchnik and "bot".
+The goal was to create a bot that can be programmed to travel around and collect coins.
+
+
+
+## Issues
+
+currently under linux the project can be build but upon executing a program in the GUI it will crash.
+This is likely due to an error occuring in Java Swing in the background which gets picked up by GLFW.