Readme

Z Wikipedie, otevřené encyklopedie
Skočit na: Navigace, Hledání

Readme je textový soubor, který bývá umístěn ve složceprogramem. Obsahuje základní informace o programu – jak ho nainstalovat, Všeobecné obchodní podmínky, Autory, systémové a hardwarové požadavky. Pokud je program zakoupený, soubor readme obsahuje i licenci. Může obsahovat i poděkování, přehled verzí, případně i chyby v dosud nedokončené verzi.

Formát[editovat | editovat zdroj]

Většinou bývá ve formátu .txt, může se ale jednat i o .pdf či .doc soubor, případně může jít o webovou stránku.

Překlad[editovat | editovat zdroj]

Spojení "read me" pochází z angličtiny a znamená "přečti mě". Odkazuje to na důležité informace v souboru.

Na GitHubu[editovat | editovat zdroj]

Pokud má Git repozitář (také uložiště) na GitHubu soubor README ve svém hlavním kořenovém adresáři, tento README soubor je automaticky převeden do formátovaného HTML a je představen na hlavní webové stránce gitového repozitáře, hned pod seznamem souborů a adresářů v úložišti. Mohou být použity různé jiné přípony souborů, avšak neměl by se v kořenovém adresáři v gitovém uložišti nacházet více než právě jeden soubor pojmenovaný "README".

Související články[editovat | editovat zdroj]