Skip to content
README
EntityQ539662· pop 28· linked from 82 articles

Also known as README.txt, README.md, README file

thumb|Screenshot of the README file of cURL

Wikidata facts

Image
README-cURL.png
Show 2 more facts
media type
text/x-readme
Commons category
README files
Sources (3)

via Wikidata · CC0

~4 min read

Article

6 sections
Contents
  • Content
  • History
  • Related
  • See also
  • References
  • Further reading

thumb|Screenshot of the README file of cURL

A README file contains descriptive information about the content of a directory in which the file is located. The scope of the information generally includes the files of the directory, and may include descendant directories, or even the full directory tree. The name is intended to draw a user's attention to important and orientational information about the directory content. A rule of thumb for one unfamiliar with the content of a directory is to read the README file before other files. Although the name README is often used, there are many other similar names used for the same purpose including "Read Me" and "READ.ME". Sometimes the file name includes an extension to indicate the file format such as "README.txt" for plain text or "README.md" for Markdown. The file's name is often all caps.

Gallery (2)

Connections

Categories