LISEZ-MOI

Dans la distribution et le développement de logiciels , un fichier README contient des informations sur les autres fichiers d'un répertoire ou d' une archive de logiciels informatiques . Forme de documentation , il s'agit généralement d'un simple fichier texte appelé , , , , ou (pour indiquer l'utilisation de Markdown ) READMERead MeREAD.MEREADME.txtREADME.md

Le nom du fichier est généralement écrit en majuscules. Sur les systèmes de type Unix en particulier, cela le fait ressortir – à la fois parce que les noms de fichiers en minuscules sont plus courants et parce que la lscommande trie et affiche généralement les fichiers dans l'ordre du code ASCII , dans lequel les noms de fichiers en majuscules apparaîtront en premier.

Un fichier README comprend généralement :

• Instructions de configuration
• Instructions d'installation
• Mode d'emploi
• Un manifeste de fichier (une liste de fichiers dans le répertoire ou l'archive)
• Informations sur les droits d'auteur et les licences
• Coordonnées du distributeur ou de l'auteur
• Une liste de bugs connus
• Instructions de dépannage
• Crédits et remerciements
• Un journal des modifications (généralement destiné aux autres programmeurs)
• Une section d'actualités (généralement destinée aux utilisateurs finaux )

La convention d'inclure un fichier README a commencé au milieu des années 1970. Les premiers logiciels système Macintosh installaient un fichier Lisez-moi sur le disque de démarrage, et les fichiers README accompagnaient généralement les logiciels tiers.

En particulier, il existe une longue histoire de logiciels libres et de logiciels open source incluant un fichier README ; les normes de codage GNU encouragent l'inclusion d'un tel fichier pour fournir « un aperçu général du package ».

Depuis l'avènement du Web comme plate-forme standard de facto pour la distribution de logiciels , de nombreux progiciels ont déplacé (ou parfois copié) certains des fichiers auxiliaires et éléments d'information ci-dessus vers un site Web ou un wiki , incluant parfois le fichier README lui-même, ou parfois en ne laissant derrière eux qu'un bref fichier README sans toutes les informations requises par un nouvel utilisateur du logiciel.

Le site Web d'hébergement de code source populaire GitHub encourage fortement la création d'un fichier README - s'il en existe un dans le répertoire principal (de niveau supérieur) d'un référentiel, il est automatiquement présenté sur la page d'accueil du référentiel. En plus du texte brut, divers autres formats et extensions de fichier sont également pris en charge, et la conversion HTML prend en compte les extensions - en particulier, un README.mdest traité comme un Markdown aromatisé à GitHub .

L'expression « fichier readme » est également parfois utilisée de manière générique, pour d'autres fichiers ayant un objectif similaire. Par exemple, les distributions de code source de nombreux logiciels libres (en particulier ceux qui suivent les normes Gnits ou ceux produits avec GNU Autotools ) incluent un ensemble standard de fichiers readme :

Les progiciels sont également généralement accompagnés d'un fichier FAQ et d'un TODOfichier répertoriant les améliorations prévues.