WikiLuc

Guest connection: login: Guest, password: anonymous

User Tools

Site Tools


dit:cours:prog1:projets:projet2:rendu

Rendu de projet

Éléments à fournir

  1. L'ensemble de vos fichiers sources soigneusement mis en page et soigneusement nommés dans une archive (voir ci-dessous)
  2. Un rapport de présentation pour évaluer votre contribution sans avoir à exécuter votre système. Seules les revendications (claims) et les preuves (evidences) contenues dans ce rapport seront prises en compte dans la notation (voir ci-dessous)

L'archive de vos fichiers sources doit comprendre les éléments suivants

  • L'ensemble des fichiers Caml
  • Votre fichier demo.sh
  • Un fichier README (appelé README.txt, README.md, etc.) pour expliquer le fonctionnement

Vote archive ne doit contenir aucun fichier objet résultat de la compilation, ni aucun fichier lié à l'utilisation de svn ou git, que ce soit la compilation Ocaml ou C++ ou la compilation LaTeX. Il ne doit contenir que les fichiers sources. Faites un make clean.

Votre archive ne devrait pas peser plus de quelques centaines de ko. Si elle est plus lourde, ne l'envoyez pas par mail mais déposez-la sur Filesender. Il est discourtois d'envoyer des fichiers lourds en attachement. Il est interdit d'envoyer des fichiers de plus de 1 Mo car ils risquent de bloquer les terminaux de lecture si le réseau est lent.

Vos fichiers sources doivent être directement compilables sur une installation standard Ubuntu 18.4. Vérifiez sur une machine virtuelle propre que vous n'utilisez pas de convention spéciale. Une bonne idée est de faire une vérification croisée entre vous.

Nommage des rendus

Tous vos rendus doivent être nommés avec le préfixe Nom1Nom2Nom3, avec les noms des membres du groupe sous forme Nom, avec uniquement des caractères ASCII (pas de lettres accentuées) et sans espace (les remplacer par _). La liste des préfixes ainsi formés est dans le dossier Excel du planning.

  • Pour les sources, seules les archives zip et tar.gz sont acceptées. Le fichier contenant vos sources doit être nommé prefix.zip ou prefix.tgz selon le mode d'archivage
  • Le fichier d'archivage doit s'ouvrir en créant un répertoire nommé Prefix. Tout le code doit être dans ce répertoire.
  • Pour le rapport, seuls les fichiers PDF sont acceptés. Le fichier contenant votre présentation doit être nommé prefix_presentation.pdf et celui contenant votre rapportprefix_rapport.pdf.

Les fichiers ne respectant pas cette consigne seront refusés.

Présentation des fichiers sources

  • Les fichiers C++ doivent être indentés avec un utilitaire de mise en page professionnel: uncrustify, astyle, clang-format, etc. Voir cette page pour des détails.
  • Les lignes des fichiers sources ne doivent pas dépasser 80 caractères
  • Le dommage des identificateurs doit suivre les usages recommandés en C++: here_is_my_variable, int_of_string, etc.
  • En cas de doute, suivez les bons conseils présentés par Google

Tous les fichiers d'un groupe doivent être indentés avec le même outil et suivre les mêmes conventions de nommage.

Présentation du rapport

Un rapport avec des fautes d'orthographe, des fautes de grammaire ou un niveau de langue inadapté à une publication scientifique sera refusé.

  • Pas plus de 5 pages de texte (sans compter les tests)
  • Chaque test est une figure LaTeX en 3 parties. Utiliser l'environnement minted du paquet minted avec les langages adaptées
    • Texte source: C++
    • Commande appliquée: text, shell
    • Résultat observé: text
  • Chaque test doit être commenté dans le rapport avec un renvoi \ref à la figure correspondante

Pour les figures contenant les tests, utilisez \begin{figure}[p]. Ces figures seront ainsi rassemblées sur une page.

Une bonne idée est de construire automatiquement votre rapport à partir de vos tests. Il suffit pour cela de mettre en place un script (shell ou mieux Python) qui enchaîne l'exécution des tests de manière automatique. Chaque test est défini par un fichier d'entrée test.in et un fichier d'actions test.cmd et il produit un fichier de sortie test.out.

Votre fichier LaTeX peut ensuite inclure directement ces fichiers en utilisation la commande \inputminted. Ainsi, vous êtes sûrs que votre rapport reflète bien le dernier état de vos tests.

Évaluation de la contribution

  • Votre contribution est évaluée d'après votre rapport. Vos fichiers sources ne sont là que pour prouver que vous avez bien fait ce que vous décrivez.
  • Toute revendication (claim) de votre rapport doit être validée par un ou plusieurs tests (evidence). Une revendication non validée n'est pas prise en compte dans l'évaluation.
  • Chaque point explicité dans le texte du sujet doit être traduit par une revendication et une preuve. Une bonne pratique est de recopier dans le rapport chaque point mentionné dans le sujet avec la revendication et la preuve associée, suivi éventuellement d'une discussion

Il vaut mieux en faire peu mais le faire bien. Le rapport demandé doit donc nettement séparer la partie commune du projet et la partie ouverte.

dit/cours/prog1/projets/projet2/rendu.txt · Last modified: 2018/11/28 11:25 by luc.bouge