Jeg har nettopp gaffelt et prosjekt i Github, gjort endringene osv. Dette fikk meg til å lure på: Jeg ser mest README. txt i opensource-prosjekter, og filen jeg redigerte var Readme.txt. Er dette en slags standardisering, eller burde jeg ha latt den være som den er?
Kommentarer
- All-caps hadde sannsynligvis sin start i MS-DOS, alle små bokstaver sannsynligvis fra unix arv. Ikke sikker på den store bokstaven – Mac-røtter, kanskje. Til slutt betyr det ikke ' t virkelig, bortsett fra som et spørsmål om ryddighet eller stil.
Svar
Store bokstaver skiller seg ut og gjør filen lett synlig, noe som er fornuftig fordi det sannsynligvis er det første en ny bruker ønsker å se på. (Eller i det minste burde ha sett på …) Som andre allerede har sagt, vil filnavn som begynner med en stor bokstav bli oppført før små bokstaver i ASCIIbetical sortering (LC_COLLATE=C) som hjelper til med å gjøre filen synlig ved første øyekast.
README -filen er en del av en rekke filer en bruker av en gratis programvarepakke normalt forventer å finne. Andre er INSTALL (instruksjoner for å bygge og installere programvaren), AUTHORS (liste over bidragsytere), COPYING (lisensetekst), HACKING (hvordan komme i gang for å bidra, kanskje inkludert en TODO-liste over startpunkter), NEWS (nylige endringer) eller ChangeLog (for det meste overflødig med versjonskontrollsystemer).
Dette er hva GNU-kodingsstandarder har å si om README -filen.
Distribusjonen skal inneholde en fil med navnet
READMEmed en generell oversikt over pakken:
- navnet på pakken;
- versjonsnummeret til pakken, eller referer til hvor i pakken versjonen finnes;
- en generell beskrivelse av hva pakken gjør;
- en referanse til filen
INSTALL, som skal i tur n inneholder en forklaring på installasjonsprosedyren;- en kort forklaring på eventuelle uvanlige kataloger eller filer på toppnivå, eller andre tips for lesere å finne veien rundt kilden;
- a referanse til filen som inneholder kopieringsbetingelsene. GNU GPL, hvis den brukes, skal være i en fil som heter
COPYING. Hvis GNU LGPL brukes, bør den være i en fil som heterCOPYING.LESSER.
Siden det alltid er bra å streve etter minst mulig overraskelse fra brukerne, bør du følge denne konvensjonen med mindre det er tvingende grunner til et avvik. I UNIX-verdenen ble filtypenavn tradisjonelt brukt sparsomt, så det kanoniske navnet på filen er README uten noe suffiks. Men de fleste brukere vil sannsynligvis ikke ha noen problemer med å forstå at en fil med navnet README.txt har samme betydning. Hvis filen er skrevet i Markdown , kan et filnavn som README.md også være rimelig. Unngå å bruke mer kompliserte markeringsspråk som HTML i README -filen, fordi det skal være praktisk å lese på en tekst-terminal. Du kan peke brukerne til manualen til programvaren eller den elektroniske dokumentasjonen, som kan være skrevet i et mer sofistikert format, for detaljer fra README -filen.
Svar
Tradisjonelt ble filen kalt README med store bokstaver fordi kommandolinjemiljøer som bruker alfabetisk rekkefølge, da ville plassere filen øverst. Dette gjør dem lett synlige i store kataloger.
Det er sannsynligvis en holdover fra Unix / Linux-verdenen der du vil laste ned kilder og deretter bygge programvaren din. Å ha filer som README og INSTALL øverst i visningen «listekataloginnhold» gjør det lettere å se at de er der, i stedet for å måtte bla gjennom hele innholdet fra et kommandolinjegrensesnitt. Det samme grunnleggende prinsippet fungerer også for github (og fungerer faktisk også i GUI-grensesnitt, tenk på det, så det kan fortsatt ha fortjeneste)
På ingen måte en hard regel, men veldig sannsynlig noe som alle gjør som en vane fordi andre prosjekter gjør det. Med mindre det er noen eksplisitt grunn til IKKE, bør du sannsynligvis bruke alle caps bare fordi du vil se at det blir brukt på den måten i mange andre prosjekter. Det er også standardnavnet Github bruker når du oppretter et nytt depot.
Kommentarer
- I ' ve har alltid trodd at store bokstaver var en form for vektlegging, omtrent som hvordan du har delene av store bokstaver i legalese.
- På et kommandolinjegrensesnitt er filene som går til toppen av oppføringen faktisk de som ruller ut av visningen først, så noen ganger er dette de minst synlige filene. Med mindre du alltid gjør noe sånt som
ls -l | less.
Svar
README skrives vanligvis med store bokstaver. På denne måten plasserte ls Unix-kommandoen filen nær begynnelsen av kataloglisten (store bokstaver kommer før små bokstaver i ASCII-rekkefølge).
Kommentarer
- Dette var den historiske grunnen, men
ls' t sorterer vanligvis slik på moderne systemer. - @ dan1111 Ikke sant! Takk (bare for å prøve …
LC_COLLATE="en_US.ascii" ; ls -lvsLC_COLLATE="en_US.UTF-8" ; ls -l)