Readme

Soubor README (někdy psaný jako README) je textový soubor, který poskytuje základní dokumentaci k programu. Obvykle je dodáván s instalátorem programu nebo jej instalátor nainstaluje. Většina souborů README obsahuje prostý text, některé však mohou obsahovat obrázky nebo video.

Soubory README obvykle obsahují několik kategorií informací. Většina z nich zahrnuje pokyny ke konfiguraci a používání programu, zejména pokud vyžaduje kroky, které nemusí být intuitivní. Soubor také zobrazuje informace o autorských právech a uvádí zásluhy vývojářů, takže uživatelé vědí, kdo se podílel na vývoji programu. Komplexní soubory README obsahují také kroky pro řešení problémů, které pomáhají řešit běžné potíže, a protokol změn s informacemi o posledních aktualizacích, opravách chyb a opravách.

Nyní, když téměř veškerá distribuce softwaru probíhá přes Internet, se informace uvedené v souboru README často nacházejí také na webu programu. Vývojář programu tak může informace často aktualizovat a poskytovat protokol změn, který uživatel uvidí ještě před aktualizací. Vývojář může dokonce s pomocí uživatelské základny programu vytvořit komplexnější dokumentaci pomocí wiki softwaru.