13  Read Me

How to write a read me file

Abstract

This chapter introduces researchers to the basics of a read me file.

Keywords

read me, transparent, project management

13.1 Read Me

A readme.qmd file instructs someone else to read me. It provides basic information and contextual information to a colleague who wants to replicate or check your work.

To see an example of an excellent read me file, see zero sum report read me

ImportantRequirement

You must create and submit a readme.qmd file for both your final report and team manuscript.