Un fichier README (ou Lisez-moi) est un document introductif, généralement au format texte brut (README.txt) ou Markdown (README.md), placé à la racine d’un projet logiciel, d’une bibliothèque, d’une application ou de tout ensemble de fichiers nécessitant une documentation minimale.
Il constitue la première interface informative entre le créateur du projet et ses utilisateurs ou contributeurs — notamment sur les plateformes comme GitHub. Un README bien rédigé répond aux questions essentielles :
- À quoi sert ce projet ?
- Comment l’installer et l’utiliser ?
- Comment y contribuer ?
- Sous quelle licence est-il distribué ?
Plus qu’un simple mode d’emploi, il incarne un contrat de lisibilité : clair, concis et inclusif, il témoigne de la vitalité et de l’ouverture du projet. À l’inverse, son absence ou sa négligence peut signaler un dépôt obscur, figé ou abandonné.