README Generator

README Generator

Build your README.txt

A readme is a simple text documents that describe the files and organization of your data, allowing others and your future self to understand and interpret what you've done.

This readme template is provided by McMaster University RDM Services for projects of any discipline and is adapted from Cornell's readme template and Francesco Varrato, Alain Borel and Chiara Gabella's "README file for Datasets - Best practices and template".

READMEs support the findability, accessibility, interoperability, and reusability of your dataset.

Review recent README examples in McMaster Dataverse to guide the development of your own. If you have questions while completing this document, reach out to RDM services by email or book a consultation.

Preview