README
file that contains information about other files in a directory or archive
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. 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
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
Troubleshooting instructions
Credits and acknowledgments
A changelog (usually aimed at fellow programmers)
A news section (usually aimed at end users)
History
The convention of including a README file began in the mid-1970s.
“README” enters the record as file that contains information about other files in a directory or archive. Crown Archives preserves that source wording while asking what README, file and contains can confirm, complicate or overturn.
Why this record matters
“README” is worth following because a concise public description often conceals a longer documentary argument. Here, README, file and contains provides the most credible route into that argument.
Named sources, stable identifiers and responsible institutions provide the strongest route from overview to verifiable evidence. The source revision retrieved here is dated Jul 25, 2026. The linked authority identifier is Q539662. None of the 0 selected statements returned an explicit reference.
A concise general-reference account can conceal disagreements about scope, terminology or the weight assigned to individual sources. The source lead contains qualifying language; that uncertainty should survive quotation, summary and reuse. Authority statements aid reconciliation but still require their own references, qualifiers and ranks to be checked.
How to read it
Use the entry as an orientation point, then follow its citations and revision history. Names, dates and institutional relationships should be checked against the original record.
- Subject orientation
- Search vocabulary
- Locating named sources
The closest primary source, responsible institution and strongest cited specialist reference.
Three-step research path
- Establish the record: confirm the title “README”, its source revision and the description used here.
- Expand the search: follow README primary sources, README archive and README research across catalogues and specialist indexes.
- Test the account: compare the strongest cited source with the responsible institution’s current record and note any disagreement.
Questions for further research
- Which source most directly establishes the central claim about “README”?
- Which institution is responsible for the underlying evidence?
- What terminology or title could unlock a more precise catalogue search?
Search terms from this dossier
This entry incorporates text from “README” on English Wikipedia. Contributors are listed in the page history. Text is available under the Creative Commons Attribution-ShareAlike 4.0 License. Selected authority identifiers and statements are retrieved from Wikidata under CC0; their references and qualifiers remain part of the verification path.