Instructions pour rendre le projet

La date limite de rendu est le dimanche 02 juin 2024 à 23:59
Attention : cette date est impérative, et les projets rendu après (même 1 heure plus tard) ne seront pas corrigés !
Je vous encourage d'ailleurs à rendre votre projet bien plus tôt, typiquement la semaine d'avant (il n'y a pas de nouveau sujet depuis le 16 mai).

Pour rendre votre projet, veuillez suivre scrupuleusement les points suivants :

  1. IMPORTANT :

    En tête de votre fichier README (un simple fichier texte, sans extension -- à la rigueur .md si vous l'écrivez en Markdown) commencez par répondre aux trois questions suivantes :

    1. jusqu'où avez-vous été ? qu'est-ce que vous avez fait/pas fait ?

    2. avez-vous une version graphique ? Si oui, avec quelle bibliothèque graphique (Qt (quelle version ?), WxWidget, SDL, Glut, autre [précisez]) ?

    3. combien d'heures en moyenne par personne par semaine estimez vous avoir passé sur le projet ? (essayez d'être objectif : n'oubliez pas qu'au début vous n'avez peut être pas fait grand chose, comptez sur 14 semaines, c.-à-d. la première semaine incluse, ne comptez pas le cours ni les exercices hors projet, n'oubliez pas de diviser le total par 2 car je veux une estimation moyenne par personne.)

    Continuez ensuite votre fichier README en expliquant comment « rentrer » dans votre projet, comment le lancer, comment il est organisé. Et tout message important que vous devez faire passer avant que l'on aille plus loin dans votre projet. Ce fichier README doit rester assez court (maximum 2 pages). Ce n'est pas une documentation exhaustive, mais un simple « premier contact » avec votre projet.

  2. Préparez un fichier ZIP du rendu de votre projet, incluant à la racine un fichier NOMS (format texte) contenant simplement vos noms et sections.

    Voici par exemple comment faire :

    1. Ouvrez un terminal, et rendez-vous (au moyen de la commande cd) dans le répertoire qui contient les fichiers sources de votre projet. Par exemple :

      cd myfiles/Programmation/cpp/projet_final
    2. Créez dans ce répertoire un fichier nommé NOMS, dans lequel vous inscrirez les noms, prénoms et sections de chaque membre de l'équipe.
      Par exemple :

      geany NOMS &
    3. Si nécessaire, purgez ou déplacez ailleurs (dans un autre répertoire qui ne soit pas sous celui que vous allez rendre (projet_final dans l'exemple ci-dessus), toutes les parties que vous ne voulez pas rendre.

      Par exemple :

      find -name \*~ -or -name \*.o

      (pour les voir), puis les supprimer ou les déplacer.
      ATTENTION à ce que vous faites ici, ne détruisez pas vos fichiers importants !!

      Concernant le contenu, je vous rappelle que vous devez rendre au moins  :

      • les fichiers :

        • README (tel que décrit plus haut)
        • JOURNAL (suivi hebdomadaire du déroulement de votre projet ; rappel : exemple ici)
        • REPONSES (réponses aux différentes questions dans les données)
        • CONCEPTION (explication des points importants de votre conception du projet)
        • NOMS (comme expliqué ci-dessus)
      • tous les codes sources (.cc, .h) de votre projet ainsi que le Makefile ou les fichiers .pro de Qt

      • tous les codes sources des fichiers tests (même si ceux-ci ne compilent plus. Expliquez pourquoi en commentaire et/ou dans le README).
        Pour plus de précisions, revoir le descriptif du projet et le barème.

      Vous pouvez de plus ajouter tous les fichiers qui vous semblent nécessaires, mais veillez à ne pas mettre les exécutables, ni les .o, ni les éventuels core. Veuillez les supprimer avant. Vérifiez avec la commande find donnée ci-dessus.

      Je vous encourage par ailleurs fortement à commenter votre code.

    4. Remontez d'un niveau dans votre arborescence de répertoires :

      cd ..
    5. Créez finalement l'archive à rendre, au moyen d'une commande similaire à

      zip -r COACH-gNUMERO.zip projet_final
      

      en replaçant COACH par le prénom sans accents de votre assistant-responsable (par exemple, pour Sébastien (prénom fictif) mettre sebastien) et NUMERO par votre numéro de groupe, sur 3 chiffres (avec des 0 préalables si nécessaires), tel que donné sur la page d'administration du projet. Par exemple :

      zip -r adam-g002.zip projet_final
      

      projet_final est le nom du répertoire que vous voulez rendre.

    6. Vérifiez bien le contenu du fichier avec :

      unzip -l COACH-gNUMERO.zip
      
    7. Finalement, rendez ce fichier au travers de la page Moodle du cours (en bas de la page principale).

      Ne faites qu'un seul rendu par groupe.

    Et voilà... c'est fini ! [Ouf !]


Dernière mise à jour le 15 février 2024
Last modified: Thu Feb 15, 2024