README
Software information file / From Wikipedia, the free encyclopedia
For the 2011 novel, see Reamde. For the 2022 memoir, see README.txt.
In software distribution and software development, a README file contains information about the other files in a directory or archive of computer software. A form of documentation, it is usually a simple plain text file called README
, Read Me
, READ.ME
, README.txt
,[1] or README.md
(to indicate the use of Markdown)
This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these template messages)
|
The file's name is generally written in uppercase. On Unix-like systems in particular, this causes it to stand out ā both because lowercase filenames are more common, and because the ls
command commonly sorts and displays files in ASCII-code order, in which uppercase filenames will appear first.[nb 1]