Jag har precis gafflat ett projekt i Github, gjort mina ändringar etc. Detta fick mig att undra: Jag ser mestadels README. txt i opensource-projekt och filen jag redigerade var Readme.txt. Är det här någon form av standardisering eller borde jag ha lämnat den som den är?
Kommentarer
- All-caps hade förmodligen sin start i MS-DOS, alla små bokstäver troligen från unix arv. Inte säker på den stora bokstaven med stora bokstäver – kanske Mac-rötter. I slutändan betyder det inte ' t egentligen, förutom som en fråga om städning eller stil.
Svar
Bokstäver med stora bokstäver sticker ut och gör filen lätt synlig vilket är vettigt eftersom det förmodligen är det första en ny användare vill titta på. (Eller åtminstone borde ha tittat på …) Som andra redan har sagt kommer filnamn som börjar med en stor bokstav att listas före små bokstäver i ASCIIbetical -sortering (LC_COLLATE=C) som hjälper till att göra filen synlig vid en första anblick.
README -filen är en del av en massa filer som en användare av ett gratis mjukvarupaket normalt förväntar sig att hitta. Andra är INSTALL (instruktioner för att bygga och installera programvaran), AUTHORS (lista över bidragsgivare), COPYING (licenstext), HACKING (hur man kommer igång för att bidra, kanske med en TODO-lista över startpunkter), NEWS (senaste ändringar) eller ChangeLog (oftast överflödiga med versionskontrollsystem).
Detta är vad GNU-kodningsstandarder har att säga om README -filen.
Distributionen bör innehålla en fil med namnet
READMEmed en allmän översikt över paketet:
- paketets namn;
- paketets versionsnummer, eller hänvisa till var i paketet versionen finns;
- en allmän beskrivning av vad paketet gör;
- en hänvisning till filen
INSTALL, vilket borde i tur n innehålla en förklaring av installationsproceduren;- en kort förklaring av eventuella ovanliga kataloger eller filer på toppnivå eller andra tips för läsare att hitta sig runt källan;
- a referens till filen som innehåller kopieringsvillkoren. GNU GPL, om den används, ska finnas i en fil som heter
COPYING. Om GNU LGPL används bör det finnas i en fil som heterCOPYING.LESSER.
Eftersom det alltid är bra att sträva efter minsta överraskning för dina användare, bör du följa denna konvention om det inte finns tvingande skäl för en avvikelse. I UNIX-världen användes filnamnstillägg traditionellt sparsamt så det kanoniska namnet på filen är README utan något suffix. Men de flesta användare skulle förmodligen inte ha några problem med att förstå att en fil med namnet README.txt har samma betydelse. Om filen är skriven i Markdown kan ett filnamn som README.md också vara rimlig. Undvik att använda mer komplicerade markeringsspråk som HTML i README -filen, eftersom det borde vara bekvämt att läsa på en endast textterminal. Du kan peka användare på programvarans manual eller dess online-dokumentation, som kan skrivas i ett mer sofistikerat format, för detaljer från README -filen.
Svar
Traditionellt kallades filen README i versaler eftersom kommandoradsmiljöer som använder alfabetisk ordning sedan skulle placera filen högst upp. Detta gör dem lätt synliga i stora kataloger.
Det är troligtvis en hållbarhet från Unix / Linux-världen där du skulle ladda ner källor och sedan bygga din programvara. Att ha filer som README och INSTALL högst upp i listan ”Listkataloginnehåll” gör det lättare att se att de finns där, istället för att behöva bläddra i hela innehållet från ett kommandoradsgränssnitt. Samma grundprincip fungerar också för github (och fungerar faktiskt också i GUI-gränssnitt, kom till att tänka på det, så det kanske fortfarande ha meriter)
På intet sätt en hård regel, men mycket troligt något som alla gör som vana eftersom andra projekt gör det. Om det inte finns någon uttrycklig anledning att INTE göra det, borde du förmodligen använda alla lock bara för att du kommer att se att det används så i många andra projekt. Det är också standardnamnet som Github använder när du skapar ett nytt arkiv.
Kommentarer
- I ' ve har alltid tänkt att versaler är en form av betoning, ungefär som hur du har avsnitten i versaler i juridisk ordning.
- På ett kommandoradsgränssnitt är filerna som går högst upp i listan faktiskt de som rullar ut ur sikte först, så ibland är det de minst synliga filerna. Om du inte alltid gör något som
ls -l | less.
Svar
README skrivs vanligtvis med versaler. På detta sätt placerade ls Unix-kommandot filen nära början på kataloglistan (versaler kommer före små bokstäver i ASCII-ordning).
Kommentarer
- Detta var den historiska anledningen, men
lsinte ' t sorterar vanligtvis så på moderna system. - @ dan1111 Rätt! Tack (bara för att försöka …
LC_COLLATE="en_US.ascii" ; ls -lvsLC_COLLATE="en_US.UTF-8" ; ls -l)