Sommaire

Le fichier README

Une bonne pratique lors de la création d’un dépôt consiste à expliquer le projet dans un fichier README à la racine du projet. Ce fichier est celui que vous consultez sur la page GitHub principale d’un projet. Comme exemple, il est possible de regarder les pages GitHub des projets de Django et de Bootstrap en consultant les liens suivants : README GitHub

Sur ces pages se trouve un bloc contenant les dossiers et les fichiers à la racine du projet. En dessous de ce bloc se trouve le bloc nommé README.md qui contient la présentation du projet. Le fichier README de Bootstrap contient l’extension md pour Markdown et celui de Django contient l’extension rst pour reStructuredText. Ce sont deux formats abordés dans la suite de ce chapitre.

La présentation d’un projet est très importante et ne doit pas être négligée. Cette présentation est surtout à destination des développeurs qui utiliseront ou participeront au projet. Elle doit être très claire et contenir plusieurs parties :

  • Une partie présentant le projet : ses fonctionnalités, ses dépendances, etc. Cette partie doit être la plus compréhensible possible. Même un utilisateur débutant doit comprendre cette partie sans difficulté.

  • Une partie expliquant très rapidement l’utilisation du projet. Si c’est une bibliothèque, il ...