<aside> 📘 Un 'README' est un fichier texte généralement présent à la racine d'un projet logiciel ou d'un référentiel de code source. Il sert à fournir des informations essentielles sur le projet telles que :
afin d'aider les utilisateurs et les contributeurs à comprendre rapidement le projet et à commencer à l'utiliser.
</aside>
🤨 Pourquoi devrais-je le faire ? C'est un moyen facile de répondre aux questions que votre public se posera probablement sur la manière d'installer et d'utiliser votre projet, ainsi que sur la manière de collaborer avec vous.
🧍🏻Qui devrait le faire ? Toute personne qui travaille sur un projet de programmation, en particulier si vous souhaitez que d'autres personnes l'utilisent ou y contribuent.
🗓️ Quand dois-je le faire ? Certainement avant de montrer un projet à d'autres personnes ou de le rendre public. Vous pouvez prendre l'habitude d'en faire le premier fichier que vous créez dans un nouveau projet.
📍 Où dois-je le placer ? Dans le répertoire principal du projet. C'est là qu'une personne qui découvre votre projet commencera. Les services d'hébergement de code tels que GitHub, Bitbucket et GitLab rechercheront également votre README et l'afficheront avec la liste des fichiers et des répertoires de votre projet.
💡 Retrouve les suggestions pour un bon README