Meta tags:

Headings (most frequently used words):

readme, contents, content, history, related, see, also, references, further, reading,

Text of the page (most frequently used words):
the (96), readme (41), and (31), file (28), for (22), retrieved (13), information (13), files (12), software (12), from (11), #content (11), directory (11), with (10), edit (10), this (9), wikipedia (8), page (7), history (7), instructions (7), about (6), was (6), also (6), are (6), read (6), use (5), github (5), 2020 (5), all (5), that (5), sometimes (5), source (5), txt (5), spice (5), there (5), other (5), including (5), name (5), contents (4), search (4), text (4), cs1 (4), 2019 (4), technical (4), communication (4), gnu (4), standards (4), punch (4), cards (4), one (4), system (4), have (4), programs (4), includes (4), changes (4), archive (4), changelog (4), commonly (4), names (4), main (4), hide (4), move (4), sidebar (4), table (3), view (3), contact (3), links (3), list (3), references (3), documentation (3), article (3), which (3), 2006 (3), archived (3), 1996 (3), department (3), readmes (3), 2018 (3), printed (3), tape (3), included (3), were (3), convention (3), into (3), doc (3), unix (3), pdp (3), decus (3), contains (3), sinc (3), slic (3), top (3), credits (3), new (3), see (3), bugs (3), intended (3), general (3), used (3), related (3), account (3), tools (3), languages (2), toggle (2), statement (2), code (2), privacy (2), policy (2), available (2), terms (2), may (2), you (2), wikimedia (2), inc (2), commons (2), license (2), july (2), categories (2), articles (2), jargon (2), wayback (2), french (2), test (2), maint (2), deprecated (2), archival (2), service (2), short (2), description (2), wikidata (2), community (2), org (2), part (2), english (2), original (2), issn (2), université (2), montréal (2), writing (2), notes (2), university (2), infoworld (2), 1997 (2), good (2), jstor (2), society (2), further (2), reading (2), 2015 (2), coding (2), link (2), cite (2), web (2), they (2), had (2), actual (2), else (2), time (2), because (2), these (2), caps (2), would (2), been (2), usr (2), failsafe (2), uci (2), lisp (2), most (2), california (2), trailing (2), edge (2), com (2), except (2), fortran (2), version (2), data (2), 6400 (2), variation (2), end (2), before (2), hacker (2), level (2), distribution (2), detailed (2), asked (2), alice (2), project (2), known (2), copyright (2), licensing (2), installation (2), users (2), news (2), programmers (2), acknowledgments (2), stored (2), addition (2), lists (2), what (2), website (2), repository (2), plain (2), extensions (2), particular (2), markdown (2), since (2), many (2), user (2), free (2), usually (2), aimed (2), format (2), such (2), same (2), often (2), appearance (2), upload (2), log (2), create (2), donate (2), menu (2), add, topic, mobile, cookie, statistics, developers, conduct, legal, safety, contacts, disclaimers, under, additional, apply, using, site, agree, registered, trademark, non, profit, organization, foundation, creative, attribution, sharealike, rendered, parsoid, last, edited, 2026, utc, hidden, incorporating, webarchive, template, language, sources, location, defined, january, 2022, dmy, dates, october, different, health, filenames, https, index, php, title, oldid, 1365961511, based, public, domain, machine, 1993, written, philosophy, electronic, journal, montreal, quebec, canada, 1188, 2492, les, presses, iii, surfaces, meditations, temporality, guédon, jean, claude, warwick, benjamin, andrew, livingston, brian, 1998, vol, media, group, check, your, avoid, common, windows, problems, rescigno, jeanne, august, hypertext, choice, 214, 43089876, johnson, mark, building, better, 43089849, prana, gede, artha, azriadi, treude, christoph, thung, ferdian, atapattu, thushari, david, 1327, 1573, 7616, 1007, s10664, 018, 9660, doi, 1802, 06997, arxiv, 1296, empirical, engineering, categorizing, 2014, markup, 2024, docs, www, releases, abdelhafith, omar, components, langemeier, jeff, 2011, via, stackexchange, physical, their, mag, pretty, much, anything, program, really, needed, labourous, process, involved, getting, created, ran, everything, printouts, how, supposed, punched, form, error, checking, debugging, apparently, follows, old, reem, paper, attached, loading, reference, 60s, origin, march, 1980, first, 32bit, bsd, 1979, 7th, edition, 1977, programmer, workbench, sys, lex, 1975, constitute, documented, manual, computer, science, irvine, lib, 210, through, 241, 223, 1974, circuit, analysis, described, applications, bulletin, volume, requirements, requires, its, right, adjusted, holerith, executes, 47k, forots, saves, second, mac, timing, routine, broken, three, parts, 1spice, document, describe, each, packet, originally, developed, univ, calif, berkeley, cdc, convert, decsystem, made, shown, slight, respect, shows, luck, ashley, grayson, nov, 0079, decus_20tap3_198111, november, sure, buy, 366, world, manes, stephen, eye, introduction, traditionally, containing, pointer, more, miscellaneous, revision, etc, when, hackers, invariably, relate, famous, scene, lewis, carroll, adventures, wonderland, confronts, magic, munchies, labeled, eat, drink, 978, 26268092, isbn, 378, mit, press, dictionary, raymond, eric, steven, robots, man, nfo, descript, ion, file_id, diz, planned, todo, frequently, questions, answers, faq, guide, prospective, contributors, contributing, hacking, reporting, ones, copying, install, basic, thanks, authors, metadata, instead, following, along, formal, govern, nor, them, yet, conventions, dictated, autotools, gnits, popular, hosting, strongly, encourages, creation, exists, automatically, presented, front, various, formats, supported, html, conversion, takes, treated, flavored, advent, platform, packages, moved, occasionally, copied, some, above, ancillary, pieces, itself, leaving, behind, only, brief, without, required, wiki, standard, facto, long, encourage, provide, overview, package, open, began, mid, 1970s, where, lowercase, capitalized, stand, out, appear, near, beginning, ordered, early, installed, startup, disk, accompanied, third, party, macintosh, ascii, section, fellow, troubleshooting, distributor, author, manifest, operating, configuration, lacking, standardization, varies, dramatically, acts, functionally, single, located, scope, generally, include, descendant, directories, even, full, tree, draw, attention, important, orientational, unfamiliar, although, similar, purpose, indicate, extension, rule, thumb, descriptive, screenshot, curl, uses, disambiguation, redirected, encyclopedia, item, projects, printable, download, pdf, print, export, switch, legacy, parser, get, shortened, url, permanent, here, actions, talk, українська, türkçe, srpskohrvatski, српскохрватски, русский, română, português, polski, nederlands, lietuvių, 한국어, қазақша, 日本語, italiano, bahasa, indonesia, magyar, hrvatski, עברית, français, suomi, فارسی, español, deutsch, čeština, català, العربية, personal, special, pages, recent, portal, learn, help, contribute, random, current, events, navigation, jump,

Text of the page (random words):
readme wikipedia jump to content main menu main menu move to sidebar hide navigation main page contents current events random article about wikipedia contact us contribute help learn to edit community portal recent changes upload file special pages search search appearance donate create account log in personal tools donate create account log in contents move to sidebar hide top 1 content 2 history 3 related 4 see also 5 references 6 further reading toggle the table of contents readme 26 languages العربية català čeština deutsch español فارسی suomi français עברית hrvatski magyar bahasa indonesia italiano 日本語 қазақша 한국어 lietuvių nederlands polski português română русский srpskohrvatski српскохрватски türkçe українська 中文 edit links article talk english read edit view history tools tools move to sidebar hide actions read edit view history general what links here related changes upload file permanent link page information cite this page get shortened url switch to legacy parser print export download as pdf printable version in other projects wikimedia commons wikidata item appearance move to sidebar hide from wikipedia the free encyclopedia redirected from readme software information file for other uses see readme disambiguation screenshot of the readme file of curl a readme file contains descriptive information about the content of a directory in which the file is located the scope of the information generally includes the files of the directory and may include descendant directories or even the full directory tree the name is intended to draw a user s attention to important and orientational information about the directory content a rule of thumb for one unfamiliar with the content of a directory is to read the readme file before other files although the name readme is often used there are many other similar names used for the same purpose including read me and read me sometimes the file name includes an extension to indicate the file format such as readme txt for plain text or readme md for markdown 1 the file s name is often all caps a readme file in an archive acts the same as in a directory since an archive is functionally a directory stored as a single file content edit lacking standardization the format and content of a readme file varies dramatically for a software project a readme file commonly includes information such as configuration instructions installation instructions operating instructions a file manifest a list of files in the directory or archive copyright and licensing information contact information for the distributor or author a list of known bugs 2 troubleshooting instructions 2 credits and acknowledgments a changelog usually aimed at fellow programmers a news section usually aimed at end users history edit the convention of including a readme file began in the mid 1970s 3 4 5 6 7 8 9 in unix where most file names were in lowercase the name was capitalized so it would stand out and appear near the beginning of ascii ordered lists early macintosh system software installed a read me on the startup disk and readme files commonly accompanied third party software in particular there is a long history of free software and open source software including a readme file the gnu coding standards encourage including one to provide a general overview of the package 10 since the advent of the web as a de facto standard platform for software distribution many software packages have moved or occasionally copied some of the above ancillary files and pieces of information to a website or wiki sometimes including the readme itself or sometimes leaving behind only a brief readme file without all of the information required by a new user of the software the popular source code hosting website github strongly encourages the creation of a readme file if one exists in the main top level directory of a repository it is automatically presented on the repository s front page 11 in addition to plain text various other formats and file extensions are also supported 12 and html conversion takes extensions into account in particular a readme md is treated as github flavored markdown related edit directory content metadata is sometimes stored in files in addition to or instead of a readme 13 the following table lists commonly used file names along with content of what is commonly in the file as with readme there are no formal standards that govern the file names nor the content of them yet there are conventions as dictated by gnits standards and gnu autotools readme general information authors credits thanks acknowledgments changelog a detailed changelog intended for programmers news a basic changelog intended for users install installation instructions copying license copyright and licensing information bugs known bugs and instructions on reporting new ones contributing hacking guide for prospective contributors to the project faq frequently asked questions and answers todo planned changes see also edit file_id diz descript ion nfo man page robots txt references edit raymond eric steven 1996 the new hacker s dictionary mit press pp 378 79 isbn 978 0 26268092 9 hacker s eye introduction traditionally included in the top level directory of a unix source distribution containing a pointer to more detailed documentation credits miscellaneous revision history notes etc when asked hackers invariably relate the readme convention to the famous scene in lewis carroll s alice s adventures in wonderland in which alice confronts magic munchies labeled eat me and drink me 1 2 manes stephen november 1996 readme sure before i buy pc world 14 11 366 pdp 10 archive decus 20 0079 readme txt from decus_20tap3_198111 pdp 10 trailing edge com 1974 11 27 retrieved 2018 03 03 readme txt is the doc file for spice sinc slic this failsafe tape contains the circuit analysis programs spice sinc and slic described in the applications software bulletin volume 4 requirements spice requires fortran 10 version 4 because of its use of right adjusted holerith data executes in about 47k it also includes this file the forots to go with the saves and the source for second mac the timing routine spice is broken into three parts 1spice for 2 and 3 there is a printed document to describe each of the programs these are included in the decus packet the documentation and programs were originally developed by the e e department of the univ of calif at berkeley on a cdc 6400 except to convert the fortran to the decsystem 10 no changes have been made to the programs for the test data slic and sinc have shown a slight variation with respect to the 6400 spice shows no variation good luck ashley grayson 27 nov 74 end of readme txt decus 10 lib 4 contains 10 210 through 10 241 except 10 223 pdp 10 trailing edge com 1975 03 27 retrieved 2018 03 03 the files on this failsafe tape constitute the uci lisp system they are for the most part documented in the uci lisp manual available from the department of information and computer science at the university of california irvine california programmer s workbench sys source lex readme july 1977 retrieved 2020 01 25 unix 7th edition usr doc readme 1979 retrieved 2020 01 25 first 32bit bsd usr doc readme march 1980 retrieved 2020 01 25 langemeier jeff 2011 07 29 re origin of readme retrieved 2020 01 25 via stackexchange they had readmes actual physical printed files for all of their punch cards and mag tape and pretty much anything else that was a program at that time you really needed one because of the labourous process that was involved with getting the created ran and everything else these readmes sometimes also included the actual printouts of how the punch cards were supposed to be punched as a form of error checking and debugging the convention apparently also follows the old system in that with all the punch cards a reem of paper was attached with the statement readme in caps printed on it this had all of the instructions for use and loading of the punch cards into the system for a time reference this would have been in the 60s abdelhafith omar 2015 08 13 readme md history and components retrieved 2020 01 25 cite web cs1 maint deprecated archival service link gnu coding standards releases www gnu org retrieved 2018 03 03 about readmes github docs retrieved 2024 05 31 markup github 2014 12 25 retrieved 2015 02 08 prana gede artha azriadi treude christoph thung ferdian atapattu thushari lo david 2019 06 01 categorizing the content of github readme files empirical software engineering 24 3 1296 1327 arxiv 1802 06997 doi 10 1007 s10664 018 9660 3 issn 1573 7616 further reading edit johnson mark 1997 02 01 building a better readme technical communication 44 1 society for technical communication 28 36 jstor 43089849 rescigno jeanne august 1997 hypertext good choice for readme files technical communication 44 3 society for technical communication 214 jstor 43089876 livingston brian 1998 09 14 check your readme files to avoid common windows problems infoworld vol 20 no 37 infoworld media group inc p 34 archived from the original on 2006 11 18 retrieved 2019 06 04 benjamin andrew 1996 09 15 1993 written at department of philosophy university of warwick uk guédon jean claude ed readme writing notes meditations on the temporality of writing surfaces electronic journal in english and french iii 12 université de montréal montreal quebec canada les presses de l université de montréal 1 12 issn 1188 2492 archived from the original on 2006 02 20 retrieved 2019 06 04 archived 2006 09 19 at the wayback machine this article is based in part on the jargon file which is in the public domain retrieved from https en wikipedia org w index php title readme oldid 1365961511 categories software documentation filenames community health files hidden categories articles with short description short description is different from wikidata use dmy dates from october 2019 use list defined references from january 2022 cs1 maint deprecated archival service cs1 location test cs1 french language sources fr webarchive template wayback links wikipedia articles incorporating text from the jargon file this page was last edited on 25 july 2026 at 12 34 utc page was rendered with parsoid text is available under the creative commons attribution sharealike 4 0 license additional terms may apply by using this site you agree to the terms of use and privacy policy wikipedia is a registered trademark of the wikimedia foundation inc a non profit organization privacy policy about wikipedia disclaimers contact wikipedia legal safety contacts code of conduct developers statistics cookie statement mobile view search search toggle the table of contents readme 26 languages add topic