README

noun

say it: “REED-mee” /ˈridmi/

The file people read first in a project, saying what it does, how to install and use it, and its license.

What is a README?

A README is a project's front page: the file anyone opens first, named in capitals so it stands out. It says what the project does, how to install it, gives one example to copy, and names the license. It's usually written in Markdown as README.md, and GitHub shows it below the project's files.

# pagecheck

Checks that every web page in a folder has a <title>.

## Install

## Use

## License

MIT. See LICENSE.

In a sentence

  • “GitHub shows the project's README under its list of files.”
  • “The README showed one example to copy, so Sam's friend got the tool working in a minute.”

Level: Novice · More Software Development terms at this level

Updated