- README.md est la fiche de présentation de votre dépôt sur Github.com!
- Il doit contenir toutes les infos nécessaires pour jouer au jeu:
- Comment le compiler:
- Les librairies et outils nécessaires à la compilation (ex: libsedl2-dev, make)
- La commande de compilation (
make, =g++ ...
)
- Comment lancer le jeu (ex:
make run
ou encore./snake
) - Comment jouer au jeu / notice d’utilisation: à vous de détailler votre jeu avec ses spécificités, d’expliquer le rôle de chaque touche, etc.
- Comment le compiler:
- IMPORTANT: Contexte Linux:
- Votre programme est un programme pour Linux! Vous vous adressez donc avant tout à des utilisateurs
Linux.
- On ne parlera donc pas des éléments de l’environnement propre à Windows (PowerShell, WSL, VS Code, etc.)
- Si vous l’avez testé, vous pouvez mentionner que votre code doit aussi pouvoir se compiler sur d’autres plateformes (Mac/Intel, Mac/ARM64, Windows?, etc.) .
- Votre programme est un programme pour Linux! Vous vous adressez donc avant tout à des utilisateurs
Linux.
- Votre projet final devra avoir ses sources à la racine du dépôt Git (sur vos PC =
~/proj7/snake/
) - Placez votre fichier
Makefile
à la racine du dépôt avec les sources afin que la commandemake
fonctionne correctement. - Exemple:
README.md Makefile MainSDLWindow.cpp MainSDLWindow.hpp main.cpp snake.cpp snake.hpp