La documentation sur un projet doit être placée dans un fichier README.md (français) à la racine du dossier de projet (ou du dépôt GitHub).

Un modèle de README pour modifier est disponible ici.

2.3.1. La documentation doit inclure :

Résumé

• Un paragraphe court et descriptif qui introduit le projet

Captures d’écran

• 2 à 4 images
• Résolution idéale 1920 x 1080 px, format png ou jpg

Nom de l’élève

Pour les travaux d’équipe

• Le nom des membres de l’équipe
• Inclure une adresse de contact par personne (ex. courriel institutionnel ou professionnel)

Logiciel(s) utilisé(s)

• Toujours nommer la version; ex. Unreal Engine 5.6.1

Crédits (essentiels pour les ressources externes utilisées)

• Citation avec le nom de la source, lien pour la source, type de licence et droits d’auteur.

Cours et date de création (année et session).