Qu'est-ce que le format de fichier README ?
Un fichier .readme est un fichier de documentation en texte brut suivant la convention README de la culture Unix et du logiciel libre. L'extension .readme est une variante peu commune des formes traditionnelles README en majuscules (sans extension) et README.txt.
Les fichiers README fournissent une documentation d'introduction lisible par l'homme pour un paquet logiciel, un projet ou une archive. Le contenu typique comprend une description du projet, des instructions d'installation et d'utilisation, des informations sur l'auteur et un avis de licence. Il n'y a pas de structure obligatoire - le contenu est composé de prose libre et de listes.
Le README en majuscules sans extension remonte au moins aux années 1970 dans les distributions Unix, où il était conventionnellement le premier fichier qu'un utilisateur était censé lire ; les gestionnaires de paquets et les listes de répertoires l'affichaient souvent automatiquement. README.txt est devenu courant sur Windows. Depuis environ 2008, README.md (Markdown) est devenu la forme dominante car GitHub affiche automatiquement le Markdown sur les pages de dépôt.
L'extension .readme se trouve occasionnellement dans d'anciennes distributions de shareware et certains gestionnaires de paquets, mais ne présente aucune distinction technique par rapport au .txt - les deux sont du texte brut que n'importe quel éditeur ouvre sans configuration. L'encodage est généralement UTF-8 (moderne) ou ASCII (hérité) ; les outils Windows peuvent produire des fichiers UTF-16 LE avec un BOM, mais l'UTF-8 est la norme. La taille du fichier est presque toujours inférieure à 100 Ko.
Sécurité et sûreté
RISQUE : LOWFichier texte brut ; aucun code exécutable ; totalement sûr à ouvrir dans n'importe quel éditeur de texte.
Détails du format
en brefProgrammes qui ouvrent les fichiers README
Windows3 apps
Windows Notepad
Intégré Le double-clic peut ne pas fonctionner (l'OS peut ne pas reconnaître l'extension .readme) ; clic droit → Ouvrir avec → Notepad. 
Notepad
Open-source Clic droit → Ouvrir avec → Notepad++ ; ou glisser-déposer sur la fenêtre de Notepad++. 
Visual Studio Code
Open-source Fichier → Ouvrir le fichier, sélectionnez le fichier .readme ; s'affiche comme du texte brut. 
macOS2 apps
Visual Studio Code
Open-source Fichier → Ouvrir le fichier, sélectionnez le fichier .readme ; s'affiche comme du texte brut. 
Linux2 apps
Détails techniques
spécifications approfondies| Encodage | UTF-8 (norme moderne) ; ASCII (hérité) ; occasionnellement UTF-16 LE avec BOM sur Windows |
| Conteneur | Texte brut - pas d'enveloppe binaire, pas d'en-tête, pas de schéma |
| Structure obligatoire | Aucune - prose libre ; pas de champs définis ni d'ordre requis |
| Variantes de noms de fichiers courantes | README (sans extension), README.txt, README.md, .readme |
| Type MIME | text/plain |
| Taille de fichier typique | Presque toujours inférieure à 100 Ko |
| Fins de ligne | LF (Unix/macOS/Linux) ou CRLF (Windows) ; les deux sont acceptés par les éditeurs de texte |
| BOM UTF-8 | Optionnel - possible sur les fichiers créés sous Windows (préfixe EF BB BF) |
| Forme moderne dominante | README.md (Markdown), rendu automatiquement par GitHub, GitLab et Bitbucket depuis ~2008 |
| Affichage historique | Affiché automatiquement par les premières listes de répertoires Unix et les gestionnaires de paquets |
| Plateformes associées | Tous les systèmes d'exploitation - Windows, macOS, Linux, Unix |
| Contenu typique | Description du projet, instructions d'installation/utilisation, infos auteur, avis de licence |
| Publié | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Dernière version | N/A - no versioning |
| Standard ouvert | Oui · libre de droits |
Conversions README
Q&R de la communauté
posées par les utilisateursPas encore de questions - soyez le premier à poser une question sur les fichiers README.
