Qu'est-ce qu'un fichier README?
Un fichier Lisez-moi est un fichier texte souvent fourni avec un logiciel. Il contient des informations générales ou des instructions sur le logiciel. La nature spécifique de ces informations varie considérablement d’un fichier à l’autre; un fichier Lisez-moi peut contenir des instructions d'installation, des informations générales sur l'utilisation du logiciel, des conditions de service et d'autres informations juridiques, ou toute autre information relative au logiciel. Presque tous les fichiers Lisez-moi comprennent au moins le nom et la version du logiciel, le nom de la société ou de la personne qui a développé le logiciel et la date de publication. Il n’existe cependant pas de formule générale pour écrire un fichier Lisez-moi et, à la fin, le contenu dépend des caprices du développeur.
Le nom "readme" est destiné à attirer l’attention de l’utilisateur sur le fichier car il contient souvent les informations nécessaires au bon fonctionnement du logiciel. Dans de nombreux cas, le nom du fichier lisez-moi sera mis en majuscule et s'appellera "README.txt" ou quelque chose de similaire. Certains répertoires de programmes déplacent les noms de fichiers en majuscules en tête de liste, ce qui leur permet de mettre en évidence le fichier Lisez-moi et de les encourager à lire le fichier avant d’utiliser le programme. Certains fichiers Lisez-moi sont en fait intitulés "Lisez-moi d'abord" ou quelque chose de similaire pour encourager davantage les lecteurs à consulter la documentation avant d'exécuter le logiciel.
Un fichier Lisez-moi peut contenir de nombreux types d’informations plus ou moins importantes. Outre les noms et les versions des fichiers, qui sont généralement inclus, les fichiers Lisez-moi incluent souvent un historique des versions ou un journal des modifications qui répertorie les modifications apportées au logiciel au fil du temps. Un fichier Lisez-moi peut également inclure une liste de problèmes connus ou de bugs affectant l'utilisation du logiciel. Certaines contiennent des informations moins essentielles telles que des remerciements ou des messages personnels de l’équipe de développement. Pour les programmes particulièrement simples, le fichier lisez-moi peut en réalité servir de manuel d’utilisateur qui explique l’utilisation générale du logiciel.
Les fichiers readme élaborés sont très rares, car les développeurs préfèrent généralement présenter les informations nécessaires de manière simple, claire et concise. Un fichier Lisez-moi est généralement présenté dans un format de texte brut avec une police standard et sans images, sauf si le développeur estime que quelque chose de plus élaboré est nécessaire. Cette simplicité supprime les distractions inutiles et garde le lecteur concentré sur les informations. Parfois, un fichier Lisez-moi est présenté dans un format de «questions fréquemment posées» ou de FAQ. Dans un tel format, le développeur prédit les questions les plus courantes que les utilisateurs peuvent avoir à propos du logiciel et fournit des réponses claires et simples au lieu de présenter toutes les informations techniques dans un bloc de texte que les utilisateurs ne sont peut-être pas enclins à lire.