README
Pronunciation: READ-mee
A plain-text or Markdown document placed at the root of a software repository that provides an introductory overview, installation instructions, and usage information for the project.
Full Definition
The README (typically named README.md when written in Markdown) is the primary entry point for anyone encountering a software project for the first time. It conventionally covers the project's purpose, prerequisites, installation steps, usage examples, contribution guidelines, and licence. In editorial contexts, 'README' is always uppercased (as it is a filename convention inherited from early Unix systems). Editors should flag lowercase usage ('readme') as non-standard. The README is distinct from fuller API reference documentation or a wiki.
Usage
Usage note: Always uppercase: README. The file extension (.md, .txt) is typically omitted when referring to the document by name in prose.
In Context
- "Update the README whenever a new configuration option is added." — Open-source contribution checklist
- "The README provides a five-minute quick-start that gets a local instance running immediately." — Project documentation review