Guide d'installation (Manual) - JulianKerignard/ProjetJeuDeLaVie_POO GitHub Wiki

Bien sûr ! Voici la version mise à jour du guide d'installation en Markdown avec toutes les informations ajoutées et des emojis pour rendre la lecture plus agréable :

Guide d'installation pour le Jeu de la Vie 🛠️

Prérequis 📋

Avant de pouvoir installer et exécuter le code, assurons-nous que vous disposez de tous les éléments nécessaires sur votre système :

  • Une version de C++ compatible avec le standard C++11 ou une version ultérieure
  • La bibliothèque SFML, qui sera utilisée pour l'interface graphique
  • CMake, un système de génération de fichiers de compilation croisée

Ces trois éléments sont essentiels pour pouvoir compiler et faire fonctionner le Jeu de la Vie. Prenons le temps de les installer correctement sur votre machine si ce n'est pas déjà fait.

Installation des dépendances

Pour les utilisateurs de WSL/Linux, utilisez les commandes suivantes pour installer les dépendances nécessaires :

sudo apt-get update
sudo apt-get install build-essential cmake libsfml-dev

Instructions d'installation 👨‍💻

⚠️ ATTENTION : Assurez-vous d'avoir installé les dépendances. Pour toute aide, merci de créer une Issue via GitHub. ⚠️

Maintenant que nous avons tout ce qu'il faut, nous pouvons passer à l'installation du code source. Commençons par le télécharger depuis le lien que vous avez partagé :

  1. Rendez-vous sur la page de la dernière version du projet : [https://github.com/JulianKerignard/ProjetJeuDeLaVie_POO/releases/tag/Final)
  2. Cliquez sur le bouton "Source code (zip)" pour télécharger l'archive contenant le code.
  3. Décompressez l'archive sur votre machine.

Une fois que vous avez le code source en main, suivez ces étapes pour le compiler et l'exécuter :

  1. Ouvrez un terminal et naviguez jusqu'au dossier où vous avez décompressé le code.

  2. Créez un dossier de compilation, qui servira à stocker les fichiers générés par CMake :

    mkdir build
cd build

  3. Utilisez CMake pour configurer le projet et générer les fichiers de compilation :

    cmake ..

  4. Compilez le projet en utilisant les fichiers générés par CMake :

    cmake --build .

  5. Lorsque la compilation sera terminée, vous pourrez enfin exécuter le programme :

    ./jeu-de-la-vie

Et voilà ! Vous devriez maintenant pouvoir lancer le Jeu de la Vie sur votre machine. 🎮

Soumettre des contributions 🤝

Si vous souhaitez contribuer au projet, n'hésitez pas ! Voici les étapes à suivre :

  1. Créez une nouvelle branche pour votre contribution :

    git checkout -b ma-nouvelle-fonctionnalite

  2. Apportez les modifications nécessaires et testez votre code.

  3. Ajoutez et validez vos changements :

    git add .
git commit -m "Ajout de ma nouvelle fonctionnalité"

  4. Poussez votre branche sur le dépôt distant :

    git push origin ma-nouvelle-fonctionnalite

  5. Créez une nouvelle demande d'extraction (pull request) sur GitHub. 🔍

    • Décrivez les changements apportés.
    • Expliquez pourquoi ces changements sont bénéfiques pour le projet.