docs: mise à jour du README.md

- Ajout de la description du projet.
- Ajout des branches en développement.
- Ajout des instructions d'installation et de configuration.
- Mise à jour de la section To do.
This commit is contained in:
2024-12-18 16:00:43 +01:00
parent c2d786c151
commit cfc15cdb2c

View File

@@ -1,4 +1,57 @@
# bloubloulespoissons
Bloublou les poissons est un jeu de simulation de comportement de poisson en réseau ou bien en solo.
Le jeu est codé en C++ avec la librairie SDL2.
# 🌱 Branches en développement
- `main` : La branche principale du projet
- `WII-U` : La branche pour la version Wii-U du jeu
- `SDL3-2.0` : La branche pour la version SDL3 du jeu
# 🚀 Installation et configuration
## Prérequis
- [SDL2](https://www.libsdl.org/download-2.0.php)
- [SDL2_image](https://www.libsdl.org/projects/SDL_image/)
- [SDL2_ttf](https://www.libsdl.org/projects/SDL_ttf/)
- [SDL2_mixer](https://www.libsdl.org/projects/SDL_mixer/)
- [SDL2_net](https://www.libsdl.org/projects/SDL_net/)
- [CMake](https://cmake.org/download/)
- [Git](https://git-scm.com/downloads)
- [GCC](https://gcc.gnu.org/)
- [Make](https://www.gnu.org/software/make/)
## Lancement avec la binaire
1. Téléchargez la dernière version de l'application
```bash
https://github.com/BreizhHardware/bloubloulespoissons/releases
```
2. Executez le fichier .exe
3. Jouez
## Compilation et lancement
1. Clonez le dépôt
```bash
git clone https://github.com/BreizhHardware/bloubloulespoissons.git
cd bloubloulespoissons
```
2. Créez un dossier build
```bash
mkdir build
cd build
```
3. Générez les fichiers de configuration
```bash
cmake ..
```
4. Compilez le projet
```bash
make -j
```
5. Lancez le jeu
```bash
./bloubloulespoissons
```
# To do
- [x] Voir les autres joueurs
@@ -8,4 +61,4 @@
- [x] Requin adversaire
- [x] Choix des musiques pour le jeux
- [x] Pouvoir mute les musiques via la touche M
- [ ] Refactorer le code pour le rendre plus lisible
- [x] Refactorer le code pour le rendre plus lisible