ReadMe Files

The ReadMe file must contain:

• domain-specific minimum information about the provenance of the data set,
• keywords,
• information about data licenses,
• a description of the dataset.

The dataset description must also include:

• a brief description of the contents of each individual file or groups of related files,
• explanations of the file format if it is not widely used or clearly recognizable from the file extension,
• explanations regarding the software required to open the files if the formats are proprietary or specific,
• relationships between files if the data set contains several files that link to each other,
• explanation of the content and structure of file folders,
• the dates the files were created and updated (versioned), along with an explanation of the updates,
• information about related data that was obtained but not included in the data set.

More detailed information about ReadMe files can be found at the Cornell University website where you can also download the ReadMe sample file template in English.

The description should be understandable to experts in the same research field so that they can reuse the data without assistance from the authors.

Source: https://dirrosdata.ctk.uni-lj.si/en/metapodatki/oblikovanje-metapodatkov/