PŘEČTĚTE SI - README

Soubor README pro kučera

A PŘEČTĚTE SI soubor obsahuje informace o dalších souborech v a adresář nebo archiv počítače software. Forma dokumentace, je to obvykle jednoduché prostý text soubor s názvem Přečtěte si mě, PŘEČTĚTE SI,[1] README.TXT,[2][1] README.md[1] (pro textový soubor pomocí snížení označení), README.1ST[1] - nebo jednoduše PŘEČTĚTE SI.[1]

Název souboru je obvykle psán velkými písmeny. Na Unixový zejména díky systémům je to snadno patrné - jednak proto, že jsou běžnější malá jména souborů, jednak proto, že je příkaz seřadí a zobrazí soubory v Objednávka kódu ASCII, takže se nejprve zobrazí velká jména souborů.[poznámka 1]

Obsah

Obsah obvykle zahrnuje jednu nebo více z následujících položek:

Dějiny

Není jasné, kdy konvence začala, ale existují příklady z poloviny 70. let.[4][5][6][7][8][9][1][je zapotřebí lepší zdroj ] Systémový software Early Macintosh nainstaloval soubor Read Me na spouštěcí disketu a obvykle doprovázel software třetích stran.

Zejména existuje dlouhá historie svobodný software a open-source software včetně souboru README; ve skutečnosti je to požadavek v Standardy kódování GNU.[10][je zapotřebí lepší zdroj ]

Od příchodu web jako de facto Standard platforma pro distribuce softwaru Mnoho softwarových balíků přesunulo (nebo příležitostně zkopírovalo) některé z výše uvedených pomocných souborů a informací do a webová stránka nebo wiki, někdy včetně samotného souboru README, nebo někdy po sobě zanechává pouze krátký soubor README bez všech informací požadovaných novým uživatelem softwaru.

V novější době populární GitHub proprietární Git úložiště[11] důrazně doporučuje soubor README - pokud je jeden obsažen v hlavním adresáři (nejvyšší úrovně), automaticky se zobrazí na hlavní webové stránce. Zatímco je podporován tradiční prostý text, podporovány jsou také různé přípony a formáty souborů,[12] a převod do HTML bere v úvahu příponu souboru - zejména by se soubor „README.md“ považoval za Markdown s příchutí GitHub soubor.

Jako obecný termín

Výraz „soubor readme“ se také někdy používá obecně pro soubory s podobným účelem.[Citace je zapotřebí ] Například zdrojový kód distribuce mnoha svobodný software balíčky, zejména ty, které následují Standardy Gnits nebo ty vyrobené s GNU Autotools, zahrnout standardní sadu souborů readme:

PŘEČTĚTE SIObecná informace
AUTORIÚvěry
DÍKPoděkování
ZMĚNAPodrobný seznam změn určený pro programátory
ZPRÁVYZákladní seznam změn určený pro uživatele
NAINSTALUJTEInstrukce k instalaci
KOPÍROVÁNÍ / LICENCEInformace o autorských právech a licencích
HMYZZnámé chyby a pokyny k hlášení nových
PŘÍSPĚVEK / HACKINGPrůvodce pro potenciální přispěvatele do projektu

Mezi další soubory běžně distribuované se softwarem patří a FAQ a a DĚLAT seznam možných budoucích změn souboru.

Viz také

Poznámky

  1. ^ Často tomu tak již není - ale LC_ALL = C ls zobrazí starší chování.

Reference

  1. ^ A b C d E F Abdelhafith, Omar (2015-08-13). "README.md: Historie a součásti". Archivováno od původního dne 2020-01-25. Citováno 2020-01-25.
  2. ^ Raymond, Eric Steven (1996). The New Hacker's Dictionary. MIT Stiskněte. 378–79. ISBN  978-0-26268092-9. Úvod Hackerova oka je tradičně obsažen v adresáři nejvyšší úrovně zdrojové distribuce Unixu, který obsahuje ukazatel na podrobnější dokumentaci, kredity, různou historii revizí, poznámky atd. […] Na otázku hackeři vždy spojují konvenci README slavná scéna ve filmech Alice's Adventures In Wonderland od Lewise Carrolla, kde Alice konfrontuje magické munchy označené „Eat Me“ a „Drink Me“.
  3. ^ A b Mánes, Stephen (Listopad 1996). „README? Jistě - než si koupím!“. PC svět. 14 (11): 366.
  4. ^ „Archiv PDP-10: decus / 20-0079 / readme.txt z decus_20tap3_198111“. pdp-10.trailing-edge.com. 1974-11-27. Citováno 2018-03-03. [README.TXT je soubor DOC pro SPICE / SINC / SLIC] Tato páska bezpečná proti chybám obsahuje programy pro analýzu obvodů SPICE SINC a SLIC popsané v části Bulletin Applications Software Volume 4. Požadavky: SPICE vyžaduje FORTRAN-10 verze 4 kvůli svému použití Správně upravená Holerithova data. Provede za přibližně 47 tis. […] Zahrnuje také tento soubor, FOROTY, které mají jít s SAVES a zdrojem pro SECOND.MAC, časovací rutinu. SPICE je rozdělena do tří částí: 1SPICE.FOR, 2 a 3. K popisu každého z programů je tištěný dokument. Ty jsou součástí paketu DECUS. Dokumentaci a programy původně vytvořilo oddělení E.E. na Univ. Kalifornie v Berkeley na CDC 6400. S výjimkou převodu FORTRANU na DECsystem-10 nebyly v programech provedeny žádné změny. Pro testovací data SLIC a SINC ukázaly mírné variace vzhledem k 6400, SPICE nevykazuje žádné variace. Hodně štěstí! Ashley Grayson 27-LIST-74 [konec souboru README.TXT]
  5. ^ „DECUS 10-LIB-4 Obsahuje 10-210 až 10-241, kromě 10-223“. pdp-10.trailing-edge.com. 1975-03-27. Citováno 2018-03-03. Soubory na této pásce FAILSAFE tvoří systém UCI LISP. Jsou z velké části dokumentovány v příručce UCI LISP, která je k dispozici na Katedře informačních a počítačových věd na Kalifornské univerzitě v Irvine v Kalifornii. [1]
  6. ^ „Programátorský pracovní stůl / sys / source / lex / README“. Červenec 1977. Citováno 2020-01-25.
  7. ^ „Unix 7. vydání / usr / doc / README“. 1979. Citováno 2020-01-25.
  8. ^ „První 32bitový BSD usr / doc / README“. Březen 1980. Citováno 2020-01-25.
  9. ^ Langemeier, Jeff (2011-07-29). „Re: Origin of README“. Citováno 2020-01-25 - prostřednictvím Stackexchange. [...] měli README (skutečné fyzické tištěné soubory) pro všechny své děrovací karty a magnetofony a skoro všechno, co bylo „programem“. V té době jste opravdu potřebovali jeden kvůli labouristickému procesu, který zahrnoval získání vytvořeného, ​​běžícího a všeho dalšího. Tyto soubory README někdy obsahovaly také skutečné výtisky toho, jak měly být děrné štítky děrovány, jako forma kontroly chyb a ladění. Konvence zjevně navazuje na starý systém v tom, že ke všem děrovacím kartám byla připojena „reem“ papíru s vytištěným výrokem README v čepicích, které obsahovaly všechny pokyny k použití a načtení děrovacích karet do systému . Z časového hlediska by to bylo v 60. letech. […]
  10. ^ „Standardy kódování GNU: zprávy“. www.gnu.org. Citováno 2018-03-03.
  11. ^ „Web pro sdílení kódu Github dosáhl pěti let a zasáhl 3,5 milionu uživatelů, 6 milionů úložišť“. TheNextWeb.com. 11.04.2013. Citováno 2013-04-11.
  12. ^ „Označení“. GitHub. GitHub. 2014-12-25. Citováno 2015-02-08.

Další čtení

Tento článek je částečně založen na Soubor žargonu, který je ve veřejné doméně.