From Wikipedia, the free encyclopedia
Readme je textový soubor, který bývá umístěn ve složce s programem. Obsahuje základní informace o programu:
Pokud je program zakoupený, obsahuje tento soubor i licenci. Může obsahovat také poděkování, přehled verzí, případně i chyby v dosud nedokončené verzi.
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.
Spojení „read me“ pochází z angličtiny, což česky znamená „přečti mě“. Odkazuje to na důležité informace v souboru.
Pokud má Git repozitář (také úložiště) na GitHubu soubor README
ve svém hlavním kořenovém adresáři, tak je tento soubor automaticky převeden do formátovaného HTML a je zobrazen 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 úložišti nacházet více než právě jeden soubor README
.
Může být také využit soubor README.md
se syntaxí GitHub Flavored Markdown. Tento soubor je při generování HTML upřednostněn.[1]
Seamless Wikipedia browsing. On steroids.
Every time you click a link to Wikipedia, Wiktionary or Wikiquote in your browser's search results, it will show the modern Wikiwand interface.
Wikiwand extension is a five stars, simple, with minimum permission required to keep your browsing private, safe and transparent.