Readme.txt vs README.txt

Les lettres majuscules se détachent et rendent le fichier facilement visible, ce qui est logique car cest probablement la première chose quun nouvel utilisateur voudrait regarder. (Ou du moins aurait dû regarder…) Comme dautres lont déjà dit, les noms de fichiers commençant par une majuscule seront listés avant les noms minuscules dans Tri ASCIIbétique (LC_COLLATE=C) qui permet de rendre le fichier visible au premier coup dœil.

Le README fait partie dun ensemble de fichiers quun utilisateur dun logiciel libre sattendrait normalement à trouver. Les autres sont INSTALL (instructions pour créer et installer le logiciel), AUTHORS (liste des contributeurs), COPYING (texte de la licence), HACKING (comment commencer à contribuer, peut-être en incluant une liste TODO de points de départ), NEWS (modifications récentes) ou ChangeLog (principalement redondant avec les systèmes de contrôle de version).

Voici ce que le Les Normes de codage GNU ont à dire sur le fichier README.

La distribution doit contenir un fichier nommé README avec un aperçu général du paquet:

• le nom du paquet;
• le numéro de version du package, ou indiquer où se trouve la version du package;
• une description générale de ce que fait le package;
• une référence au fichier INSTALL, qui devrait être en tur n contient une explication de la procédure dinstallation;
• une brève explication de tous les répertoires ou fichiers de premier niveau inhabituels, ou dautres astuces pour que les lecteurs puissent trouver leur chemin dans la source;
• a référence au fichier contenant les conditions de copie. La GNU GPL, si elle est utilisée, doit être dans un fichier appelé COPYING. Si le GNU LGPL est utilisé, il doit être dans un fichier appelé COPYING.LESSER.

Comme il est toujours bon de sefforcer dobtenir la moindre surprise de vos utilisateurs, vous devez suivre cette convention à moins quil ny ait des raisons impérieuses de déroger. Dans le monde UNIX, les extensions de nom de fichier étaient traditionnellement utilisées avec parcimonie, de sorte que le nom canonique du fichier est README sans aucun suffixe. Mais la plupart des utilisateurs nauraient probablement aucun problème à comprendre quun fichier nommé README.txt a la même signification. Si le fichier est écrit en Markdown , un nom de fichier tel que README.md peut également être raisonnable. Évitez cependant dutiliser des langages de balisage plus compliqués comme HTML dans le fichier README, car il devrait être pratique de lire sur un terminal de texte uniquement. Vous pouvez diriger les utilisateurs vers le manuel du logiciel ou sa documentation en ligne, qui peut être écrite dans un format plus sophistiqué, pour plus de détails dans le fichier README.

Traditionnellement, le fichier sappelait README en majuscules parce que les environnements de ligne de commande qui utilisent lordre alphabétique mettaient alors le fichier en haut. Cela les rend facilement visibles dans les grands répertoires.

Cest probablement un vestige du monde Unix / Linux où vous téléchargeriez les sources, puis construiriez votre logiciel. Avoir des fichiers comme README et INSTALL en haut de votre vue « list directory contents » le rend plus facile de voir quils sont là, au lieu davoir à parcourir tout le contenu à partir dune interface de ligne de commande. Le même principe de base fonctionne également pour github (et fonctionne également dans les interfaces GUI, pensez-y, donc il pourrait sont toujours valables)

En aucun cas une règle stricte, mais très probablement quelque chose que tout le monde fait par habitude parce que dautres projets le font. À moins quil ny ait une raison explicite de NE PAS le faire, vous devriez probablement utiliser tous caps simplement parce que vous le verrez être utilisé de cette façon dans de nombreux autres projets. Cest également le nom par défaut que Github utilise lorsque vous créez un nouveau référentiel.

Commentaires

• I ' a toujours pensé que le tout en majuscules était une forme de mise en évidence, un peu comme la façon dont vous avez les sections majuscules en juridique.
• Sur une interface de ligne de commande, les fichiers qui vont en haut de la liste sont en fait ceux qui défilent en premier, donc parfois ce sont les fichiers les moins visibles. Sauf si vous faites toujours quelque chose comme ls -l | less.

README est généralement écrit en majuscules. De cette façon, la commande Unix ls a placé le fichier près du début de la liste des répertoires (les lettres majuscules précèdent les lettres minuscules dans lordre ASCII).

Commentaires

• Cétait la raison historique, mais ls ne ' t trier généralement de cette façon sur les systèmes modernes.
• @ dan1111 Exact! Merci (juste pour essayer … LC_COLLATE="en_US.ascii" ; ls -l vs LC_COLLATE="en_US.UTF-8" ; ls -l)