README

A text file, usually README.md, at the top of a project that explains what it does and how to use it.

In more detail

It is usually written in Markdown and is the first thing people read. It says what the project does, how to use it and what it expects.

Examples

A role README documents the variables it accepts, the state it guarantees and the platforms it supports.
In Terraform: A module's README should state its purpose, inputs and outputs so a caller never has to read the implementation. The Terraform Registry shows it as the module's front page.

Related terms

Taught in

References

Certification courses