Compléter le readme racine
Le contenu du fichier README.md
à la racine du projet est important puisqu'il est le «point d'entrée» de tout nouveau contributeur potentiel.
Il faudrait y mettre au moins les informations suivantes :
- Nom du projet et description courte
- Éventuellement une ou deux captures d'écran de l'interface web, un élément visuel est toujours plus marquant
- Comment l'utiliser (brièvement)
- Quelques informations sur les grosses dépendances (Gurobi, Postgres...)
- Lien vers la doc d'installation/mise en place (sur le Wiki, dans le git ou sur une page web externe)
- Comment contribuer
- Canaux de discussion utilisés (Slack? IRC? mailing list?)
- Un petit paragraphe «ne pas hésiter à remplir une issue...» avec un lien vers les issues
- Lien vers la doc pour le développement (mise en place des dépendances de dev, outils utilisés, etc...)
- Information de licence