Dernière modification : 10/06/2022 à 14:11

Rendu du projet

Vous devrez déposer sur blackboard au plus tard le 26 juin 2022 une archive avec votre rendu final.

Votre programme doit respecter les sujets des tp 1 à 6. Si vous avez fait des choses différemment, vous devrez l'expliquer dans les documentations demandées. Le tp7 donne des idées de fonctionnalitées supplémentaires.

Consignes :

• l'archive sera nommée NOM_prenom_snake2022.tgz
• lors du désarchivage, elle devra générer un repertoire nommé NOM_prenom_snake2022/
• ce repertoire doit contenir :
  • un fichier Makefile
    • les cibles (target) suivantes doivent fonctionner :
      • snake qui permet d'obtenir un executable pour jouer au jeu
      • clean qui permet d'effacer tous les fichiers de compilation temporaires (les .o) mais pas l'executable
      • clear qui permet d'effacer tous les fichiers du répertoire bin/
      • tgz qui génère l'archive au format tgz que vous devez rendre.
  • un fichier README au fromat txt ou markdown décrivant brievement le contenu de l'archive et la procedure de complilation et lancement du programme (y compris installation de la lib MLV)
  • les sous repertoires :
    • src/ contenant les sources
    • bin/ devant être vide lorsqu'on décompresse l'archive, et contenant les .o et le (ou les) exécutables après compilation
    • doc/ contenant deux documents au format pdf
      • user.pdf : un manuel d'utilisation du programme, permettant à n'importe qui de compiler puis d'utiliser le jeu, et avec une section rapport de bugs si il y en a. Mettez vous à la place de quelqun qui télécharge votre archive et souhaite l'utiliser, quelles sont les étapes à suivre pour l'installation, puis pour lancer le jeu, quelles sont les commandes à sa disposition, etc.
      • dev.pdf : un manuel developpeur pour le projet, destiné à expliquer l'architechture du projet, les choix techniques si il y en a eu, et le rapport de bugs. Il doit permettre à n'importe quel developpeur de modifier vos sources pour ajouter des fonctionnalitées et/ou corriger des bugs. Mettez vous à la place d'un développeur qui souhaite comprendre comment votre jeu foncitonne, soit pour s'en inspirer sur un autre projet, soit pour y apporter des modifications. Si vous n'avez pas traité l'ensemble des TPs, un récapitulatif des exercices traités avec succès et de ceux non traité sera très aprécié. Si vous avez incorporé des bonus non demandé, même chose.
    • les autres repertoires nécessaires au programme (fichiers de niveaux, fichiers images de sprite, son etc. si vous en avez utilisé)
• Barème indicatif : Documentation utilisateur 7 points, Documentation développeur 8 points, Code (fonctionnement, lisibilité, commentaires, bonus...) 5 points.
  • Comme vous le voyez les documentations sont très importantes. Veillez à les rédiger sérieusement. Un document comporte toujours une introduction, une table des matières, une conclusion. Les figures y sont légendées et numérotées, une table des figures est appréciées.
  • Il n'y a pas de copié/collé de code dans une documentation. Sauf quelques lignes si c'est vraiment nécessaire d'expliquer un point particulier. Vous avez en revanche la possibilité de faire référence à du code en citant le nom du fichier et les lignes concernées si nécessaire.
  • Enfin les documentations doivent correspondre au projet rendu. Si la documentation me dit de taper make et que tout fonctionne, mais que moi j'obtient des erreurs (même facile à corrgier) c'est un soucis ! si la documentation me dit qu'il n'y a pas de bug mais que si je lance le jeu j'obtiens un segmentation fault en essayant de l'utiliser c'est un problème !