Ce document est un exemple de README pour vos répertoire de code et pour présenter vos projets. Il vous aidera à faire vos diapositives pour le pitch.
Tip
En début de README, on décrit le projet, son but et son fonctionnement de manière très succinte.
Ce projet a été développé dans le cadre du Hackathon IA et Mobilités, organisé par Île-de-France Mobilités les 21 et 22 novembre 2024. Pour en savoir plus, voici le Guide des participants et participantes.
Tip
Ici vous pouvez répondre aux questions suivantes :
- A quel problème votre projet répond-t-il ?
- Quels sont les usagers cibles ?
Tip
Ici vous pouvez présenter
- Votre solution et son fonctionnement général
- Les données mobilisées
- Comment elle répond au problème
Tip
Ici vous pouvez présenter les principaux problèmes rencontrés et les solutions apportées
Tip
Ici vous vous projetez sur comment vous auriez aimé développer votre projet si vous aviez eu plus de temps ! (Quel cas d'usage pour la suite ? Quelles ressources à mobiliser ?)
Tip
Si vous avez le temps, vous pouvez décrire les étapes d'installation de votre projet (commandes à lancer, ...) et son fonctionnement.
Ici, il faut décrire la ou les licences du projet. Vous pouvez utiliser la licence MIT, qui est très permissive. Si on souhaite s'assurer que les dérivés du projet restent Open-Source, vous pouvez utiliser la licence GPLv3.
Le code et la documentation de ce projet sont sous licence MIT.