Readme

Readme or Readme (English read me read me = ) is usually called a file that is shipped with the software, and contains the most important information that should be read before installation and first use of the software by the user.

If the file name in uppercase ( README ), the file is particularly striking and is in front of all files listed on systems that distinguish between uppercase and lowercase letters (such as Unix, and other derivatives ) whose names start with lowercase begin.

File Format

Formerly a readme file was mostly a plain text file, that is, they contained only ASCII characters, so they could be read on almost any computer system, even on systems on which the software which had described the file that are not used could. Also the written together Filename (readme instead of read me ) compatibility was owed ​​because it could cause a space in the file name to problems on some systems.

Nowadays Readme documents are often divided by a simplified markup language or delivered in HTML format, since it is assumed that most systems are equipped with a web browser. Partly also the PDF file format is used, but that requires a special viewer.

Swell

• Software component