README.md

Fichier à décrire 




***DOXYGEN***

//manque explication installation Doxywizard

Pour générer la documentation Doxygen :
1. Ouvrir Doxywizard
2. Dans "Working directory" mettre l'emplacement du jeu, là où vous l'avez téléchargé finissant en "game-insa-project"
3. Dans "Source code directory", mettre "game-insa-project/GAME" (à ajuster selon l'emplacement sur votre oridnateur) et cocher "Scan recursively"
4. Dans "Destination directory", mettre l'emplacement où vous soouhaitez générer le lien pour la documentatin
5. Page suivante "Mode", cocher "All Entities" et "Optimize for C or PHP output"
6. Page suivante "Output", cocher "with panel navigation" et décocher "LaTex"
7. Page suivante "Diagrams", cocher "No diagrams"

Pour visualiser la documentation :
1. Aller à l'emplacement défini précédemment dans "Destination directory"
2. Double-ciquer sur "Doxyfile" et éxectuer le fichier avec "doxygen.exe"
3. Un fichier html vient d'être généré, l'ouvrir et cliquer sur index.html
4. Une fenêtre s'ouvre dans votre navigateur. Vous avez maintenant accès à toute la documentation. Vous pouvez d'ailleurs directement y visualiser ce fichier.