README

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. A README file in an archive acts the same as in a directory since an archive is functionally a directory stored as a single file.

]] 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. A README file in an archive acts the same as in a directory since an archive is functionally a directory stored as a single file. ==Content== Lacking standardization, the format and content of a README file varies dramatically. For a software project, a README file commonly includes information such as: Configuration instructions Installation instructions Operating instructions A file manifest (a list of files in the directory or archive) Copyright and licensing information Contact information for the distributor or author A list of known bugs Troubleshooting instructions Credits and acknowledgments A changelog (usually aimed at fellow programmers) A news section (usually aimed at end users) ==Related== Directory content metadata is sometimes stored in files in addition to or instead of a README. The following table lists commonly-used file names along with content of what is commonly in the file. As with README, there are no formal standards that govern the file names nor the content of them. Yet, there are conventions as dictated by Gnits Standards and GNU Autotools. ==See also== FILE_ID.DIZ DESCRIPT.ION .nfo man page robots.txt ==References== ==Further reading== * [https://books.google.com/books?id=vFEEAAAAMBAJ&pg=PA34 [https://www.pum.umontreal.ca/revues/surfaces/sgml/vol3/benjami.sgml]

Text derived from https://en.wikipedia.org/w/index.php?oldid=1365961511 under CC BY-SA 4.0; modifications have been made.