Co je to 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.software.V mnoha případech bude kapitalizován název souboru souboru ReadMe a bude nazýván readMe.txt nebo něco podobného.Některé adresáře programu přesouvají kapitalizované názvy souborů na horní část seznamu souborů, takže kapitalizace dává význam souboru ReadMe a znovu povzbuzuje uživatele softwaru, aby před použitím programu přečetl soubor.Některé soubory README jsou ve skutečnosti nazvány nejprve přečtěte si mě nebo něco podobného jako dále povzbuzují čtenáře, aby se před spuštěním softwaru prohlédli dokumentaci.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 může soubor README ve skutečnosti sloužit jako příručka pro uživatele, který pokyn jeden v celkovém používání softwaru.

Propracované soubory README jsou velmi vzácné, protože vývojáři obvykle dávají přednost stanovení potřebných informací jednoduchým, čistým, čistým, a stručný způsob.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 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 namísto stanovení všech technických informací v bloku textu, který mohou být lidé přečteni.