Jeg har lige forkedlet et projekt i Github, foretaget mine ændringer osv. Dette fik mig til at spekulere på: Jeg ser mest README. txt i opensource-projekter, og den fil, jeg redigerede, var Readme.txt. Er dette en slags standartisering, eller skulle jeg have ladt den være som den er?
Kommentarer
- All-caps havde sandsynligvis sin start i MS-DOS, alle små bogstaver sandsynligvis fra unix arv. Ikke sikker på det store bogstav med store bogstaver – måske Mac-rødder. I sidste ende betyder det ikke ' t virkelig, undtagen som et spørgsmål om ryddighed eller stil.
Svar
Store bogstaver skiller sig ud og gør filen let synlig, hvilket giver mening, fordi det sandsynligvis er det første, en ny bruger ønsker at se på. (Eller i det mindste skulle have kigget på …) Som andre allerede har sagt, vises filnavne, der starter med et stort bogstav, før små bogstaver i ASCIIbetical sortering (LC_COLLATE=C), som hjælper med at gøre filen synlig ved første øjekast.
README -filen er en del af en masse filer, som en bruger af en gratis softwarepakke normalt forventer at finde. Andre er INSTALL (instruktioner til opbygning og installation af softwaren), AUTHORS (liste over bidragydere), COPYING (licenstekst), HACKING (hvordan man kommer i gang med at bidrage, eventuelt med en TODO-liste over startpunkter), NEWS (nylige ændringer) eller ChangeLog (for det meste overflødige med versionskontrolsystemer).
Dette er, hvad GNU kodningsstandarder har at sige om README filen.
Distributionen skal indeholde en fil med navnet
READMEmed en generel oversigt over pakken:
- navnet på pakken;
- pakkens versionsnummer, eller henvis til, hvor i pakken versionen kan findes;
- en generel beskrivelse af, hvad pakken gør;
- en henvisning til filen
INSTALL, som skulle være i tur n indeholder en forklaring på installationsproceduren;- en kort forklaring på usædvanlige kataloger eller filer på øverste niveau eller andre tip, som læsere kan finde rundt i kilden;
- a henvisning til filen, der indeholder kopieringsbetingelserne. GNU GPL skal, hvis den bruges, være i en fil med navnet
COPYING. Hvis GNU LGPL bruges, skal den være i en fil, der hedderCOPYING.LESSER.
Da det altid er godt at stræbe efter mindst mulig overraskelse fra dine brugere, skal du følge denne konvention, medmindre der er tvingende grunde til en afvigelse. I UNIX-verdenen blev filnavneudvidelser traditionelt brugt sparsomt, så filens kanoniske navn er README uden noget suffiks. Men de fleste brugere har sandsynligvis ingen problemer med at forstå, at en fil med navnet README.txt har samme betydning. Hvis filen er skrevet i Markdown , kan et filnavn som README.md muligvis også være rimelig. Undgå at bruge mere komplicerede markup-sprog som HTML i README -filen, dog fordi det skal være praktisk at læse på en kun tekstterminal. Du kan pege brugere på manualen til softwaren eller online-dokumentationen, der muligvis skrives i et mere sofistikeret format, for at få flere oplysninger fra README -filen.
Svar
Traditionelt blev filen kaldt README med store bogstaver, fordi kommandolinjemiljøer, der bruger alfabetisk rækkefølge, derefter ville placere filen øverst. Dette gør dem let synlige i store kataloger.
Det er højst sandsynligt en holdover fra Unix / Linux-verdenen, hvor du ville downloade kilder og derefter opbygge din software. At have filer som README og INSTALL øverst i visningen “List Directory Content” gør det lettere at se, at de er der, i stedet for at skulle gennemse hele indholdet fra en kommandolinjegrænseflade. Det samme grundlæggende princip fungerer også for github (og fungerer faktisk også i GUI-grænseflader, kom til at tænke på det, så det kan stadig har fortjeneste)
På ingen måde en hård regel, men meget sandsynligt noget, som alle gør som en vane, fordi andre projekter gør det. Medmindre der er en eksplicit grund til IKKE, skal du sandsynligvis bruge alle hætter bare fordi du vil se, at det bruges på den måde i mange andre projekter. Det er også standardnavnet, som Github bruger, når du opretter et nyt lager.
Kommentarer
- I ' ve har altid troet, at store bogstaver var en form for vægt, ligesom hvordan du har delene med store bogstaver i legalese.
- På en kommandolinjegrænseflade er de filer, der går øverst på listen, faktisk de, der først ruller ud af syne, så nogle gange er det de mindst synlige filer. Medmindre du altid gør noget som
ls -l | less.
Svar
README skrives normalt med store bogstaver. På denne måde placerede ls Unix-kommandoen filen nær begyndelsen af kataloglisten (store bogstaver kommer før små bogstaver i ASCII-rækkefølge).
Kommentarer
- Dette var den historiske grund, men
lsbetyder ikke ' t typisk sortere sådan på moderne systemer. - @ dan1111 Højre! Tak (bare for at prøve …
LC_COLLATE="en_US.ascii" ; ls -lvsLC_COLLATE="en_US.UTF-8" ; ls -l)