README

A readme (or read me) file contains information about other files in a directory or archive and is commonly distributed with computer software, forming part of its documentation. Such a file is usually a text file called README.TXT, README.md, README.1ST, READ.ME, or simply README, although some 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.

README is traditionally written in upper case, so that on case-preserving environments that display files in an ASCIIbetical ordering by default, such as the ls command in Linux, the name will appear near the beginning of a directory listing (since upper-case letters sort before lower-case letters in ASCIIbetical ordering).

Contents

The contents typically include one or more of the following:

  • Configuration instructions
  • Installation instructions
  • Operating instructions
  • A file manifest (list of files included)
  • Copyright and licensing information
  • Podcasts:

    PLAYLIST TIME:

    Readme

    by: Backjumper

    In the 21st century society has turned its target through
    the annhilation of the human beeing.
    Well, the next step will be creating a new kind of
    devices for mind control and slavery.
    So from now on the decision lays in your hands.
    It's a philosophy, a state of psyche, it's the choice to
    trust no one.
    Leave it or embrace it before they set you off.




    ×