README files
In general, a README file contains information regarding the structure and contents of a project or a dataset, and it should always be located in the top folder of the files it describes. Typically, a README file is a plain text file written in an open format such as text format (.txt). The target audience for the README file is potential users of your data, including yourself and your research collaborators. It is good practice to create a first version of the README file at the start of a new project, and then update it as the project progresses.
Content of a README file
The content could either be on a higher project-level or on a more detailed data-level. Templates for README files on the two levels can be found below.
Manifest files
A manifest file can function as a complement to a README file and could contain a list of all files that are part of the project the README file covers. Just as the README file, a manifest file is generally a text file written in an open format such as text format (.txt). The target audience for the manifest is the same as for the README file, i.e. potential users of your data, including yourself and your research collaborators.
Resources
Please find below resources concerning README files in form of training, guidance and/or tools.