What is README?

A README is the introductory document at the root of a software project, explaining what it is, how to install it and how to use it. Code-hosting platforms render it on the repository landing page.

2 tools that work with README

Files never leave your browser.

Text Tools1

Markdown Editor & ViewerWrite markdown with a live preview, outline, formatting toolbar and one-click HTML, PDF or .md export.

Samples & Mock Data1

Sample Markdown GeneratorGenerate Markdown documents exercising every feature — tables, code, footnotes, task lists and more.

Related terms

Terms that appear alongside README on the same tools.

← All glossary terms Browse every tool →