Readme.txt vs. README.txt (Čeština)

Všechna velká písmena vynikají a usnadňují viditelnost souboru, což dává smysl, protože je to pravděpodobně první věc, na kterou by se nový uživatel chtěl podívat. (Nebo alespoň měli se podívat na…) Jak již řekli ostatní, názvy souborů začínající velkým písmenem budou uvedeny před malými písmeny v ASCIIbetical třídění (LC_COLLATE=C), které pomáhá soubor na první pohled zviditelnit.

README soubor je součástí spousty souborů, které by uživatel bezplatného softwarového balíčku normálně očekával najít. Ostatní jsou INSTALL (pokyny pro sestavení a instalaci softwaru), AUTHORS (seznam přispěvatelů), COPYING (text licence), HACKING (jak začít přispívat, možná včetně seznamu TODO výchozích bodů), NEWS (poslední změny) nebo ChangeLog (většinou redundantní u systémů pro správu verzí).

To je to, co GNU Coding Standards musí říkat o souboru README.

Distribuce by měla obsahovat soubor s názvem README s obecným přehledem balíčku:

• název balíčku;
• číslo verze balíčku nebo se podívejte, kde v balíčku najdete verzi;
• obecný popis toho, co balíček dělá;
• odkaz na soubor INSTALL, který by měl být v tur n obsahuje vysvětlení postupu instalace;
• krátké vysvětlení neobvyklých adresářů nebo souborů nejvyšší úrovně nebo jiné rady, jak se čtenáři orientovat ve zdroji;
• a odkaz na soubor, který obsahuje podmínky kopírování. GNU GPL, pokud se používá, by mělo být v souboru s názvem COPYING. Pokud se používá GNU LGPL, měl by být v souboru s názvem COPYING.LESSER.

Protože je vždy dobré usilovat o co nejmenší překvapení vašich uživatelů, měli byste se řídit touto konvencí, pokud neexistují přesvědčivé důvody pro odchylku. Ve světě UNIX se přípony názvů souborů tradičně používaly střídmě, takže kanonický název souboru je README bez jakékoli přípony. Ale většina uživatelů by pravděpodobně neměla žádné potíže s pochopením, že soubor s názvem README.txt má stejný význam. Pokud je soubor zapsán v Markdown , může být také název souboru jako README.md rozumné. Nepoužívejte však v souboru README složitější značkovací jazyky, jako je HTML, protože by mělo být pohodlné číst pouze na textovém terminálu. Uživatelé můžete odkázat na příručku k softwaru nebo jeho on-line dokumentaci, která může být napsána v propracovanějším formátu, kde získáte podrobnosti ze souboru README.

Soubor se tradičně jmenoval README velkými písmeny, protože prostředí příkazového řádku, které používá abecední řazení, by soubor umístilo na začátek. Díky tomu jsou snadno viditelné ve velkých adresářích.

S největší pravděpodobností jde o pozdržení ze světa Unix / Linux, kde byste stahovali zdroje a poté vytvářeli svůj software. Díky souborům jako README a INSTALL v horní části zobrazení „seznam obsahu adresáře“ je to snazší vidět, že tam jsou, místo toho, aby museli procházet celý obsah z rozhraní příkazového řádku. Stejný základní princip funguje také pro github (a ve skutečnosti funguje také v grafických rozhraních, přemýšlejte o tom, takže by stále si zasloužíte zásluhy)

V žádném případě není to tvrdé pravidlo, ale je velmi pravděpodobné, že to každý dělá jako zvyk, protože to dělají jiné projekty. Pokud pro to neexistuje nějaký výslovný důvod, měli byste pravděpodobně použít všechny čepice jen proto, že uvidíte, že se to takto používá v mnoha dalších projektech. Je to také výchozí pojmenování, které Github používá při vytváření nového úložiště.

Komentáře

• I ' vždy jsem si myslel, že velká písmena jsou formou důrazu, podobně jako to, jak máte části velkých písmen v legalese.
• Na rozhraní příkazového řádku jsou soubory, které přejdou na začátek seznamu, ve skutečnosti ty, které se jako první posouvají mimo zobrazení, takže někdy se jedná o nejméně viditelné soubory. Pokud neuděláte vždy něco jako ls -l | less.

Soubor README se obvykle píše velkými písmeny. Tímto způsobem ls příkaz Unix umístil soubor na začátek seznamu adresářů (velká písmena jsou před malými písmeny v pořadí ASCII).

Komentáře

• Toto byl historický důvod, ale ls není ' t obvykle se tak dělí na moderních systémech.
• @ dan1111 Správně! Děkuji (jen vyzkoušet … LC_COLLATE="en_US.ascii" ; ls -l vs LC_COLLATE="en_US.UTF-8" ; ls -l)