Un fichier README est un fichier texte qui introduit et explique un projet. Il contient des informations communément requises pour comprendre le sujet du projet. Les services d'hébergement de code tels que GitHub , Bitbucket et GitLab demandent que votre projet comporte un fichier README.

Théoriquement les fichiers README peuvent être écrits dans n'importe quel format de fichier texte. Mais dans la pratique Markdown, qui est un langage de balisage léger, est utilisé pour la mise en forme de texte brut. Le fichier README devient alors README.md ainsi qu'on peut le voir dans les projets hébergés par GitHub.

L'outil readme-md-generator est capable de lire votre environnement (packqhe JSON, git config, etc.) pour vous suggérer les réponses par défaut durant le processus de création du fichier README.md. Ainsi que le montre l'animation ci-dessous, et le résultat produit par readme-md-generator pour le projet readme-md-generator :-)

readme-md-generator est un logiciel libre sous licence MIT disponible sur GitHub.