Readme

Un fichier README (parfois écrit en majuscules, README) est un fichier texte qui fournit une documentation de base sur un programme. Il est généralement fourni avec l'installateur d'un programme ou installé par celui-ci. La plupart des fichiers README sont en texte brut, même si certains peuvent inclure des images ou des vidéos.

Les fichiers README contiennent généralement plusieurs catégories d'informations. La plupart incluent des instructions pour configurer et utiliser le programme, en particulier si celui-ci nécessite des étapes qui ne sont pas forcément intuitives. Ils affichent également les informations de copyright et les crédits du développeur, afin d'indiquer aux utilisateurs qui a participé au développement du programme. Les fichiers README détaillés incluent aussi des étapes de dépannage pour résoudre les problèmes courants, ainsi qu'un journal des modifications récentes, des corrections de bogues et des correctifs.

Maintenant que presque toute la distribution des logiciels se fait sur Internet, les informations présentées dans un fichier README se trouvent souvent aussi sur le site web du programme. Le développeur du programme peut ainsi mettre fréquemment les informations à jour et fournir un journal des modifications que l'utilisateur peut consulter avant d'effectuer une mise à jour. Le développeur peut même créer une documentation plus détaillée avec l'aide des utilisateurs du programme, en utilisant un logiciel de type wiki.