Readme
|
|
A readme (or read me) file contains information about other files in a directory and is very commonly distributed with computer software. Such a file is virtually always an ASCII text file, called "README.TXT", "README.1ST", "READ.ME", or simply "README". The contents vary, usually featuring operating instructions, and often a list of the names and purposes of files one should expect to be there or information about the maker of the files.
Open source software packaged in source form often includes a readme file as well as other documentation -- for instance an "INSTALL" file with installation instructions, a changelog, and a copy of the license under which the software is distributed. Other files might include an FAQ, and a "TODO" file listing possible future changes.
The name read me may remind readers of the tags drink me and eat me on magical items consumed by Alice of Alice in Wonderland.
'readme' is also the name of a software art festival (Aarhus 2004, Helsinki 2003, Moscow 2002) created by Alexei Shulgin and Olga Goriunova, amongst others.