Create README.md

This commit is contained in:
Mathias Wagner 2024-11-25 22:16:12 +01:00
parent 50ffe0f575
commit 0c85c17b0d

View File

@ -1,3 +1,45 @@
# ObstacleGame
<br />
<div align="center">
<a href="https://git.gnm.dev/Mathias/ObstacleGame/">
<img src="https://git.gnm.dev/Mathias/ObstacleGame/raw/branch/main/res/logo.png" alt="Logo" width="200" height="200">
</a>
</div>
## 🎮 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.