README
From Wikipedia, the free encyclopedia
A readme (or read me) file contains information about other files in a directory or archive and is very commonly distributed with computer software. Such a file is usually a text file called README.TXT, README.1ST, READ.ME, or simply README, although some Microsoft Windows software may include a README.WRI, README.RTF, or README.DOC. The name is chosen such that even if one were not aware that there might typically be a readme file, they would be drawn to read it because of the name. It is in upper case so that on case-preserving environments using an ASCIIbetical ordering, the name will appear near the beginning of a directory listing (since upper-case letters sort before lower-case letters in ASCIIbetical ordering).
The contents typically include one or more of the following:
- configuration instructions
- installation instructions
- operating instructions
- a file manifest
- copyright and licensing information
- contact information for the distributor or programmer
- known bugs
- troubleshooting
- credits and acknowledgments
- a changelog
The expression "readme file" is also sometimes used descriptively and generically, whereby the files are not named "readme", but are considered types of readme files. The source code distributions of many free software packages, especially those following the Gnits Standards or those produced with GNU Autotools, usually include a standard set of readme files:
-
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 Copyright and licensing information BUGS Known bugs and instructions on reporting new ones
Other files commonly distributed with software include a FAQ and a TODO file listing possible future changes.
[edit] Other uses
- 'readme' is the name of a software art festival (Aarhus 2004, Helsinki 2003, Moscow 2002) created by Alexei Shulgin and Olga Goriunova, among others.
- "Readme" is the name of Michael Kinsley's column in the magazine Slate. [1]
- 'readme' is the name of a student-produced weekly humor publication at Carnegie Mellon University. [2]
[edit] Sources
This article is based in part on the Jargon File, which is in the public domain.
