Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

What is This Guidance About?

This guide will describe This article describes the types of information that should be included within a README file . READMEs are useful documents that include metadata relevant to your research project and assist secondary users in understanding the contents and structure of your research materials.

What is a README?

A README is a text document that can be used to capture information about your research project. It should describe your research project, the materials (data, code, etc.), and how your files are organized. Additional information such as methodology, data cleaning, data citations, access instructions, and licensing or terms of use may also be included within a README.

...