README

README

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::

Other files commonly distributed with software include a FAQ and a TODO file listing possible future changes.

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". [http://www.slate.com/?id=3944&cp=2147]
* 'readme' is the name of a student-produced weekly humor publication at Carnegie Mellon University. [http://www.activitiesboard.org/readme.php]

ources

*Jargon


Wikimedia Foundation. 2010.

Игры ⚽ Нужен реферат?

Look at other dictionaries:

  • Readme.cc — ist eine von der EU geförderte Internetplattform, die es Lesern ermöglicht, sich über Bücher auszutauschen. Das interkulturelle Portal ist bereits in zehn Sprachen übersetzt, und nach dem erforderlichen Planungszeitraum ging readme.cc im Frühling …   Deutsch Wikipedia

  • Readme — (engl. read me = lies mich) heißt üblicherweise eine Datei, die mit Software geliefert wird und die wichtigsten Informationen enthält, die der Benutzer vor der Installation und der ersten Verwendung der Software lesen sollte.[1] Ist der Dateiname …   Deutsch Wikipedia

  • README — Un fichier readme (lisezmoi en français) est, en informatique, un fichier contenant des informations sur les autres fichiers d un répertoire. Un tel fichier est généralement un fichier texte appelé « README.TXT »,… …   Wikipédia en Français

  • Readme.cc — is a web 2.0 Internet portal for books and readers supported by the European Commission. It is currently available in ten languages. Following years of development Readme.cc was published on line in the spring of 2008. History The idea for the… …   Wikipedia

  • README — Der Begriff Readme (engl. read me = lies mich) bezeichnet eine Datei, die üblicherweise zusammen mit Software ausgeliefert wird und die wichtigsten Informationen enthält, die der Benutzer vor der Installation oder aber vor der ersten Verwendung… …   Deutsch Wikipedia

  • Readme — Un fichier readme (en français, lisezmoi) est un fichier contenant des informations sur les autres fichiers du même répertoire. Un tel fichier est généralement un fichier texte appelé « README.TXT », « README.1ST »,… …   Wikipédia en Français

  • README — En español LEEME. Documento de texto que acompaña normalmente a los programas, en el cual hay información de relevancia sobre éste en cuanto a su uso, nuevas características, errores (bugs) y requisitos de hardware. Generalmente se distribuye en… …   Wikipedia Español

  • README — ● ►en np. m. ►TYPFICH LisezMoi en français. Nom standard du fichier qui contient des conseils, des notes de dernière minute, des redirections vers de plus amples informations, des informations à lire en tout premier lieu avant d utiliser un… …   Dictionnaire d'informatique francophone

  • readme — skaityk statusas T sritis informatika apibrėžtis Failo su pradine informacija, kurią rekomenduojama perskaityti prieš atliekant kokius nors veiksmus su tame kataloge esančiais duomenimis, vardas. Dažniausiai tai ↑grynojo teksto failas… …   Enciklopedinis kompiuterijos žodynas

  • README-файл — (от англ. read me  «прочти меня»)  текстовый файл, содержащий информацию о других файлах в том же каталоге или архиве; такой файл обычно сопровождает дистрибутив программы при распространении. Такой файл обычно имеет имя readme.txt …   Википедия

Share the article and excerpts

Direct link
Do a right-click on the link above
and select “Copy Link”