README
Encyclopedia
A readme file contains information about other files in a directory
or archive and is 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 occasionally include a README.WRI
, README.RTF
, or README.DOC. The name is chosen so that users unaware of the existence of this type of file would be drawn to read it. It is traditionally written 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:
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:
Other files commonly distributed with software include a FAQ
and a TODO file listing possible future changes.
Directory (file systems)
In computing, a folder, directory, catalog, or drawer, is a virtual container originally derived from an earlier Object-oriented programming concept by the same name within a digital file system, in which groups of computer files and other folders can be kept and organized.A typical file system may...
or archive and is commonly distributed with computer software. Such a file is usually a text file
Text file
A text file is a kind of computer file that is structured as a sequence of lines of electronic text. A text file exists within a computer file system...
called README.TXT, README.1ST, READ.ME, or simply README, although some Microsoft Windows
Microsoft Windows
Microsoft Windows is a series of operating systems produced by Microsoft.Microsoft introduced an operating environment named Windows on November 20, 1985 as an add-on to MS-DOS in response to the growing interest in graphical user interfaces . Microsoft Windows came to dominate the world's personal...
software may occasionally include a README.WRI
Windows Write
Microsoft Write is a basic word processor that came with Microsoft Windows 1.0, Windows 2.0, and the Windows 3.x series. Throughout its lifespan it was minimally updated, and is comparable to early versions of MacWrite...
, README.RTF
Rich Text Format
The Rich Text Format is a proprietary document file format with published specification developed by Microsoft Corporation since 1987 for Microsoft products and for cross-platform document interchange....
, or README.DOC. The name is chosen so that users unaware of the existence of this type of file would be drawn to read it. It is traditionally written 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:
- ConfigurationComputer configurationIn communications or computer systems, a configuration is an arrangement of functional units according to their nature, number, and chief characteristics. Often, configuration pertains to the choice of hardware, software, firmware, and documentation...
instructions - InstallationInstallation (computer programs)Installation of a program is the act of putting the program onto a computer system so that it can be executed....
instructions - Operating instructions
- A file manifestManifest fileOn the Java platform, a Manifest file is a specific file contained within a JAR archive. It is used to define extension and package-related data. It is a metadata file that contains name-value pairs organized in different sections. If a JAR file is intended to be used as an executable file, the...
(list of files included) - CopyrightCopyrightCopyright is a legal concept, enacted by most governments, giving the creator of an original work exclusive rights to it, usually for a limited time...
and licensing information - Contact information for the distributor or programmer
- Known bugsSoftware bugA software bug is the common term used to describe an error, flaw, mistake, failure, or fault in a computer program or system that produces an incorrect or unexpected result, or causes it to behave in unintended ways. Most bugs arise from mistakes and errors made by people in either a program's...
- TroubleshootingTroubleshootingTroubleshooting is a form of problem solving, often applied to repair failed products or processes. It is a logical, systematic search for the source of a problem so that it can be solved, and so the product or process can be made operational again. Troubleshooting is needed to develop and...
- CreditsCredit (creative arts)In general, the term credit in the artistic or intellectual sense refers to an acknowledgement of those who contributed to a work, whether through ideas or in a more direct sense.-Credit in the arts:...
and acknowledgmentsAcknowledgment (creative arts)In the creative arts and scientific literature, an acknowledgment is an expression of gratitude for assistance in creating a literary or artistic work.... - A changelogChangelogA changelog is a log or record of changes made to a project, such as a website or software project, usually including such records as bug fixes, new features, etc...
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
Source code
In computer science, source code is text written using the format and syntax of the programming language that it is being written in. Such a language is specially designed to facilitate the work of computer programmers, who specify the actions to be performed by a computer mostly by writing source...
distributions of many free software
Free software
Free software, software libre or libre software is software that can be used, studied, and modified without restriction, and which can be copied and redistributed in modified or unmodified form either without restriction, or with restrictions that only ensure that further recipients can also do...
packages, especially those following the Gnits Standards
Gnits Standards
The Gnits standards are a collection of standards and recommendations for programming, maintaining, and distributing software. They are published by a group of GNU project maintainers who call themselves "Gnits", which is short for "GNU nit-pickers"...
or those produced with GNU Autotools, usually include a standard set of readme files:
| README | General information |
| AUTHORS | Credits |
| THANKS | Acknowledgments |
| ChangeLog Changelog A changelog is a log or record of changes made to a project, such as a website or software project, usually including such records as bug fixes, new features, etc... |
A detailed changelog, intended for programmers |
| NEWS | A basic changelog, intended for users |
| INSTALL | Installation instructions |
| COPYING / LICENSE | Copyright and licensing information |
| BUGS | Known bugs and instructions on reporting new ones |
Other files commonly distributed with software include a FAQ
FAQ
Frequently asked questions are listed questions and answers, all supposed to be commonly asked in some context, and pertaining to a particular topic. "FAQ" is usually pronounced as an initialism rather than an acronym, but an acronym form does exist. Since the acronym FAQ originated in textual...
and a TODO file listing possible future changes.
Other uses
- "readme" is the name of a software art festival (AarhusAarhusAarhus or Århus is the second-largest city in Denmark. The principal port of Denmark, Aarhus is on the east side of the peninsula of Jutland in the geographical center of Denmark...
2004, HelsinkiHelsinkiHelsinki is the capital and largest city in Finland. It is in the region of Uusimaa, located in southern Finland, on the shore of the Gulf of Finland, an arm of the Baltic Sea. The population of the city of Helsinki is , making it by far the most populous municipality in Finland. Helsinki is...
2003, MoscowMoscowMoscow is the capital, the most populous city, and the most populous federal subject of Russia. The city is a major political, economic, cultural, scientific, religious, financial, educational, and transportation centre of Russia and the continent...
2002) created by Alexei ShulginAlexei ShulginAlexei Shulgin is a Russian born contemporary artist, musician, and online curator. Working out of Moscow and Helsinki, Shulgin established the Immediate Photography Group in 1988 and started his career in this area of study...
and Olga Goriunova, among others. - "Readme" is the name of Michael KinsleyMichael KinsleyMichael Kinsley is an American political journalist, commentator, television host, and pundit. Primarily active in print media as both a writer and editor, he also became known to television audiences as a co-host on Crossfire...
's column in the magazine SlateSlate (magazine)Slate is a US-based English language online current affairs and culture magazine created in 1996 by former New Republic editor Michael Kinsley, initially under the ownership of Microsoft as part of MSN. On 21 December 2004 it was purchased by the Washington Post Company...
. - "readme" is the name of a student-produced weekly humor publication at Carnegie Mellon UniversityCarnegie Mellon UniversityCarnegie Mellon University is a private research university in Pittsburgh, Pennsylvania, United States....
.