README

Definition

A README is a file included in a folder, also called a directory, to explain how to use and understand other files in the directory. It is typically saved as a .txt file to allow it to be opened and read on any system.

A readme file provides information about a data file and is intended to help data be correctly interpreted, by yourself at a later date or by others when sharing or publishing data.

 

Further Resources

Cornell provides a guide on writing READMEs https://data.research.cornell.edu/content/readme

Search for a Term

Send us your feedback or suggestions for new terms

Contact information
CAPTCHA This question is to prevent spam submissions. Contact nwso@hshsl.umaryland.edu for any accessibility issues.
6 + 14 =
Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.