Readme.txt vs. README.txt

Alle hoofdletters vallen op en maken het bestand gemakkelijk zichtbaar, wat logisch is omdat dit waarschijnlijk het eerste is dat een nieuwe gebruiker zou willen bekijken. (Of, had in ieder geval moeten hebben gekeken naar …) Zoals anderen al hebben gezegd, worden bestandsnamen die beginnen met een hoofdletter in ASCIIbetical sortering (LC_COLLATE=C) wat helpt om het bestand in een eerste oogopslag zichtbaar te maken.

De README -bestand maakt deel uit van een aantal bestanden dat een gebruiker van een gratis softwarepakket normaal zou verwachten te vinden. Andere zijn INSTALL (instructies voor het bouwen en installeren van de software), AUTHORS (lijst met bijdragers), COPYING (licentietekst), HACKING (hoe te beginnen met bijdragen, misschien inclusief een TODO-lijst met startpunten), NEWS (recente wijzigingen) of ChangeLog (meestal redundant met versiebeheersystemen).

Dit is wat de GNU-coderingsstandaarden te zeggen hebben over het README -bestand.

De distributie moet een bestand bevatten met de naam README met een algemeen overzicht van het pakket:

• de naam van het pakket;
• het versienummer van het pakket, of verwijs naar waar in het pakket de versie kan worden gevonden;
• een algemene beschrijving van wat het pakket doet;
• een verwijzing naar het bestand INSTALL, wat in tur n bevatten een uitleg van de installatieprocedure;
• een korte uitleg van ongebruikelijke mappen of bestanden op het hoogste niveau, of andere hints voor lezers om hun weg in de bron te vinden;
• een verwijzing naar het bestand dat de kopieervoorwaarden bevat. De GNU GPL, indien gebruikt, zou in een bestand met de naam COPYING moeten staan. Als de GNU LGPL wordt gebruikt, moet deze zich in een bestand met de naam COPYING.LESSER bevinden.

Aangezien het altijd goed is om te streven naar de minste verrassing van uw gebruikers, dient u deze conventie te volgen, tenzij er dwingende redenen zijn voor een afwijking. In de UNIX-wereld werden bestandsnaamextensies traditioneel spaarzaam gebruikt, dus de canonieke naam van het bestand is README zonder enig achtervoegsel. Maar de meeste gebruikers zullen waarschijnlijk geen moeite hebben om te begrijpen dat een bestand met de naam README.txt dezelfde betekenis heeft. Als het bestand is geschreven in Markdown , kan een bestandsnaam als README.md ook zijn redelijk. Vermijd echter het gebruik van ingewikkelder opmaaktalen zoals HTML in het README -bestand, omdat het gemakkelijk zou moeten zijn om te lezen op een terminal met alleen tekst. U kunt gebruikers verwijzen naar de handleiding van de software of de bijbehorende online documentatie, die misschien in een meer geavanceerd formaat is geschreven, voor details uit het bestand README.

Traditioneel heette het bestand README in hoofdletters, omdat opdrachtregelomgevingen die alfabetische volgorde gebruiken het bestand dan bovenaan plaatsen. Hierdoor zijn ze gemakkelijk zichtbaar in grote mappen.

Het is hoogstwaarschijnlijk een overblijfsel uit de Unix / Linux-wereld waar je bronnen zou downloaden en dan je software zou bouwen. Met bestanden zoals README en INSTALL bovenaan je “lijst met directory-inhoud” -weergave maakt het gemakkelijker te zien dat ze er zijn, in plaats van door de volledige inhoud te moeten bladeren vanaf een opdrachtregelinterface. Hetzelfde basisprincipe werkt ook voor github (en werkt eigenlijk ook in GUI-interfaces, denk er nu over na, dus het kan nog steeds de verdienste)

In geen geval een harde regel, maar zeer waarschijnlijk iets dat iedereen uit gewoonte doet omdat andere projecten het doen. Tenzij er een expliciete reden is om het NIET te doen, zou u waarschijnlijk alle caps alleen omdat je zult zien dat het op die manier in veel andere projecten wordt gebruikt. Het is ook de standaardnaam die Github gebruikt wanneer je een nieuwe repository maakt.

Reacties

• I ' heb altijd gedacht dat alleen hoofdletters een vorm van nadruk waren, net zoals u de delen van hoofdletters in legalese gebruikt.
• Op een opdrachtregelinterface zijn de bestanden die naar de top van de lijst gaan in feite de bestanden die als eerste uit beeld scrollen, dus soms zijn dit de minst zichtbare bestanden. Tenzij je altijd zoiets doet als ls -l | less.

README wordt meestal in hoofdletters geschreven. Op deze manier plaatste het ls Unix-commando het bestand aan het begin van de directorylijst (hoofdletters komen voor kleine letters in ASCII-volgorde).

Opmerkingen

• Dit was de historische reden, maar ls doet ' t sorteert meestal op die manier op moderne systemen.
• @ dan1111 Juist! Bedankt (gewoon om te proberen … LC_COLLATE="en_US.ascii" ; ls -l vs LC_COLLATE="en_US.UTF-8" ; ls -l)