diff --git a/README.md b/README.md index 0ce5975..f6467ce 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,45 @@ -# ObstacleGame +
+
+ + Logo + +
-Entwickelt für die Berufschule: Ein Spiel, in welchem du Gegnern ausweichen musst. \ No newline at end of file + +## 🎮 Obstacle Game + +Entwickelt für die Berufschule: Ein Spiel, in welchem du Gegnern ausweichen musst. + +### ⬇️ Installation + +1. Clone the repo + ```sh + git clone https://git.gnm.dev/Mathias/ObstacleGame.git + ``` + +2. Install SDL2, SDL2_image, SDL2_ttf, SDL2_mixer + ```sh + sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev + ``` + +3. Install CMake + ```sh + sudo apt-get install cmake + ``` + +4. Build the project + ```sh + mkdir build + cd build + cmake .. + make + ``` + +5. Run the project + ```sh + ./ObstacleGame + ``` + +### 📝 License + +Distributed under the MIT License. See `LICENSE` for more information.