Skip to content

Files

Latest commit

3e3c991 · Jan 16, 2025

History

History
17 lines (9 loc) · 1016 Bytes

04-03-readme-template.md

File metadata and controls

17 lines (9 loc) · 1016 Bytes

The README template

Researchers are encouraged (sometimes required) to adhere to a particular documentation standard. We have found that providing a template is useful to allow for complete coverage of all the topics a researcher should address in their README, which describers what to do with their package. The typical replication package needs information on data (provided or not), code (how to run it, and what is required), and the computational infrastructure necessary to be able to run the code.

:::{note}

Presentation of this section

:::

Additional reading

Peruse the template README provided by a collective of data editors. You will hold researchers to this standard.