Co je soubor README?
Soubor README je textový soubor, který je často součástí softwaru, který obsahuje obecné informace nebo pokyny o softwaru. Specifická povaha této informace se významně liší od souboru k souboru; 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 zahrnují alespoň jméno a verzi softwaru, název společnosti nebo jednotlivce, který software vyvinul, a datum zveřejnění. Neexistuje však žádný obecný vzorec pro psaní README a nakonec obsah závisí na rozmaru vývojáře.
Jméno „Readme“ je určeno k tomu, aby na soubor upoutal pozornost uživatele, protože často obsahuje informace nezbytné k řádnému provozování softwaru. V mnoha případech bude název souboru ReadMe kapitalizován a bude nazýván „readMe.txt“ nebo něco podobného. Někteří programový ředitelS Přesuňte názvy souborů kapitalizovaného na horní část seznamu souborů, takže kapitalizace dává význam souboru ReadMe a znovu povzbuzuje uživatele softwaru, aby si soubor přečetl před použitím programu. Některé soubory README jsou ve skutečnosti nazvány „Přečtěte mě nejprve“ nebo něco podobného, aby dále povzbuzovaly čtenáře, aby se před spuštěním softwaru prohlédli dokumentaci.
Soubor README může obsahovat mnoho různých druhů informací o různých významech. Kromě jmen a verzí souborů, které jsou obecně zahrnuty, soubory README často zahrnují také historii verzí nebo ChangeLog, která uvádí změny provedené softwarem v průběhu času. README může také zahrnovat seznam známých problémů nebo chyb, které ovlivňují použití softwaru. Některé zahrnují méně nezbytné informace, jako jsou potvrzení nebo osobní zprávy od vývojového týmu. Pro obzvláště jednoduché programy mohou soubor README Actually Slouží jako uživatelská příručka, která instruuje jeden v celkovém používání softwaru.
Propracované soubory README jsou velmi vzácné, protože vývojáři obvykle upřednostňují potřebné informace 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ář necítí, že je nutné něco propracovanějšího. Tato jednoduchost odstraňuje zbytečné rozptýlení a udržuje čtenáře zaměřenou na informace. Někdy je soubor README prezentován v „často kladených otázkách“ nebo ve formátu FAQ. V takovém formátu vývojář předpovídá nejběžnější otázky, které lidé mohou mít o softwaru, a poskytuje jasné a jednoduché odpovědi místo toho, aby rozložil všechny technické informace v bloku textu, který mohou být lidé přečteni.