README files

README.txt files are text files (.txt) containing key contextual information about a project or dataset. This information is intended to ensure that the data can be correctly interpreted when it is used or reused. It is customary to include the word README, in capital letters, in the file name.

Characteristics

In principle, every data directory structure should contain at least one primary README file located at the root of the directory. Additional README files may also be included to accompany folders or files that require specific information.

A primary README file should contain at least the following information:

  • The names of the principal investigator and co-investigators of the study
  • A description of the methodology and tools used for data collection
  • The dates of data collection
  • A description of the directory hierarchy, the type of data it contains and the file naming convention
  • A complete list of all titles/codes/abbreviations and conventions used in the files.
  • The conditions for sharing and access (licensing) during and after the end of the project.

All of this information corresponds to the main types of metadata. For more information on this topic see the page: "Creating metadata".

How to create a readme file?

README files are very simple and can be created manually, without the need to follow any specific standards or use controlled vocabulary, as they need to be easily understandable to humans.

McMaster University in Canada offers a tool, in the form of an online form, to help you create your own README based on the Cornell University template.

mcmaster-readme-generator.png
As with all research data documentation actions, it is best to create READMEs or at least document the information you will want to include in them at the beginning of the data collection or even during the planning phase.

README example
4TU.ResearchData published an example of a README file they recieved in their data repository.