Co je soubor README?
Soubor readme je textový soubor, který je často součástí softwaru, který obsahuje obecné informace nebo pokyny k softwaru. Specifická povaha těchto informací se v jednotlivých souborech výrazně liší; soubor readme může obsahovat pokyny k instalaci, obecné informace o používání softwaru, podmínky služby a další právní informace nebo jakékoli jiné informace týkající se softwaru. Téměř všechny soubory readme obsahují alespoň název a verzi softwaru, název společnosti nebo jednotlivce, který software vyvinul, a datum vydání. Neexistuje však obecný vzorec pro psaní readme a nakonec závisí obsah na rozmarech vývojáře.
Název "readme" je určen k tomu, aby uživatele upozornil na soubor, protože často obsahuje informace nezbytné pro správné fungování softwaru. V mnoha případech bude název souboru readme velkým písmenem a bude se jmenovat „README.txt“ nebo něco podobného. Některé adresáře programů přesouvají velká a velká písmena názvů souborů na začátek jakéhokoli seznamu souborů, takže velká písmena dávají souboru readme význam a znovu vybízí uživatele softwaru, aby soubor před použitím programu přečetl. Některé soubory readme jsou ve skutečnosti označeny jako „read me first“ (první čtení) nebo něco podobného, které čtenáře dále povzbuzují k prohlížení dokumentace před spuštěním softwaru.
Soubor readme může obsahovat mnoho různých druhů informací různého významu. Kromě názvů a verzí souborů, které jsou obvykle zahrnuty, soubory readme také často obsahují historii verzí nebo seznam změn, který uvádí změny provedené v softwaru v průběhu času. Soubor Readme může také obsahovat seznam známých problémů nebo chyb, které ovlivňují používání softwaru. Některé zahrnují méně důležité informace, jako jsou potvrzení nebo osobní zprávy od vývojového týmu. U zvláště jednoduchých programů může soubor readme ve skutečnosti sloužit jako uživatelská příručka, která dává pokyn jednomu z celkového používání softwaru.
Vypracované soubory readme jsou velmi vzácné, protože vývojáři obvykle upřednostňují rozložení potřebných informací jednoduchým, jasným a stručným způsobem. Soubor readme je obvykle prezentován ve formátu prostého textu se standardním písmem a bez obrázků, pokud se vývojář nedomnívá, že je nutné něco komplikovanějšího. Tato jednoduchost odstraňuje zbytečné rozptýlení a udržuje čtenáře zaměřeného na informace. Soubor readme je někdy prezentován ve formátu „často kladených otázek“ nebo FAQ. V takovém formátu vývojář předpovídá nejčastější otázky, které lidé mohou mít ohledně softwaru, a poskytuje jasné a jednoduché odpovědi namísto rozložení všech technických informací do bloku textu, které mohou být lidé odhodláni číst.