A Readme.txt és a README.txt

A nagybetűk kiemelkednek és könnyen láthatóvá teszik a fájlt, aminek van értelme, mert valószínűleg ez az első dolog, amit egy új felhasználó meg akar nézni. (Vagy legalábbis nek meg kellett volna néznie…) Amint azt mások már mondták, a nagybetűvel kezdődő fájlnevek a ASCIIbetical rendezés (LC_COLLATE=C), amely első pillantásra elősegíti a fájl láthatóságát.

A README fájl egy csomó fájl része, amelyet egy ingyenes szoftvercsomag felhasználója általában elvár. Mások: INSTALL (a szoftver felépítésével és telepítésével kapcsolatos utasítások), AUTHORS (a közreműködők listája), COPYING (licencszöveg), HACKING (hogyan lehet elindítani a közreműködést, esetleg a kiindulási pontok TODO-listáját is megadva), NEWS (legutóbbi módosítások) vagy ChangeLog (többnyire felesleges a verzióvezérlő rendszerekkel).

Ez az, amit a GNU kódolási szabványoknak mondani kell a README fájlt.

A terjesztésnek tartalmaznia kell egy README nevű fájlt a csomag általános áttekintésével:

• a csomag neve;
• a csomag verziószáma, vagy utaljon arra, hogy a csomag hol található a verzió;
• a csomag működésének általános leírása;
• hivatkozás a fájlra INSTALL, amelynek tur n tartalmazzák a telepítési eljárás magyarázatát;
• rövid magyarázat a szokatlan legfelső szintű könyvtárakról vagy fájlokról, vagy egyéb tippek az olvasók számára, hogy eligazodjanak a forrás körül;
• a hivatkozás a másolási feltételeket tartalmazó fájlra. A GNU GPL használatakor a COPYING nevű fájlban kell lennie. A GNU LGPL használata esetén a COPYING.LESSER nevű fájlban kell lennie.

Mivel mindig jó a felhasználók legkisebb meglepetésére törekedni, akkor kövesse ezt az egyezményt, hacsak nincs kényszerítő oka az eltérésnek. A UNIX világban a fájlnévkiterjesztéseket hagyományosan takarékosan használták, így a fájl kanonikus neve README minden utótag nélkül. De a legtöbb felhasználónak valószínűleg nem okoz gondot annak megértése, hogy a README.txt nevű fájlnak ugyanaz a jelentése. Ha a fájl Markdown fájlba van írva, akkor a README.md típusú fájlnév is lehet ésszerű. Kerülje a bonyolultabb jelölőnyelvek, például a HTML használatát a README fájlban, mert kényelmesnek kell lennie a csak szöveges terminálon történő olvasáshoz. A README fájl részleteiért a felhasználókat a szoftver kézikönyvére vagy annak on-line dokumentációjára írhatja, amely kifinomultabb formátumban írható.

Hagyományosan a fájlt README-nek hívták nagybetűvel, mert az ábécé sorrendjét használó parancssori környezetek ezt követően a fájlt a tetejére helyezték. Ez könnyen láthatóvá teszi őket a nagy könyvtárakban.

Valószínűleg visszatartó a Unix / Linux világból, ahonnan forrásokat tölthet le, majd felépítheti a szoftverét. Ha a “lista könyvtár tartalma” nézet tetején olyan fájlok vannak, mint a README és az INSTALL könnyebben belátható, hogy ott vannak, ahelyett, hogy a teljes tartalmat egy parancssori felületről kellene böngésznünk. Ugyanez az alapelv működik a github esetében is (és valójában a GUI-interfészeken is működik, gondolkodjon el rajta, szóval még mindig érdemei vannak)

Semmiképp nem kemény szabály, de nagyon valószínű, hogy mindenki szokásként cselekszik, mert más projektek csinálják. Hacsak nincs valamilyen kifejezett ok, hogy NEM, akkor valószínűleg használd az összes sapkák csak azért, mert látni fogja, hogy sok más projektben így használják. Ez egyben az alapértelmezett elnevezés is, amelyet a Github használ, amikor új tárhelyet hoz létre.

Megjegyzések

• I ' ve mindig azt gondolta, hogy a nagybetűk a hangsúly egyik formája, hasonlóan ahhoz, hogy legális formában vannak a nagybetűk.
• A parancssori felületen a lista tetejére kerülő fájlok elsőként gördülnek ki a láthatárból, így néha ezek a legkevésbé látható fájlok. Kivéve, ha mindig olyasmit csinál, mint ls -l | less.

A README-t általában nagybetűvel írják. Ily módon a ls Unix parancs a fájlt a könyvtárlista elejéhez helyezte (a nagybetűk kisbetűk elé kerülnek az ASCII-sorrendben).

Megjegyzések

• Ez volt a történelmi ok, de ls nem ' t a modern rendszereken általában így rendez.
• @ dan1111 Helyes! Köszönöm (csak azért, hogy megpróbálja … LC_COLLATE="en_US.ascii" ; ls -l vs LC_COLLATE="en_US.UTF-8" ; ls -l)