README

From Wikipedia, the free encyclopedia

You have new messages (last change).

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. The contents typically include one or more of the following:

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

[edit] See also

Retrieved from "http://en.wikipedia.org../../../r/e/a/README_c47c.html"