General Documentation Terms

What Is a README File?

A README is a text file that introduces and explains a project, common in software development.

A README is a text file (often named README.md) that introduces and explains a project. Common in software development, READMEs typically include a project description, installation instructions, usage examples, and contribution guidelines.

The README is usually the first thing a developer reads, so it should answer "what is this, why does it exist, and how do I use it?" as quickly as possible. README files are frequently written in Markdown.

← Back to the full glossary

Frequently asked questions

Why is it called a README?
The name is an instruction in itself — "read me" — signaling that it is the first file someone should open to understand the project.

Create Better Documentation with Folge

Turn your processes into clear, professional step-by-step guides. Folge automatically captures your workflow and exports to PDF, Word, HTML, and more.

System Requirements: Windows 7 ( partial support), 8, 8.1, 10, 11 (64-bit only). OSX > 10.10. Available in 🇬🇧, 🇫🇷, 🇩🇪, 🇪🇸 , 🇮🇹, 🇳🇱, 🇵🇹/🇧🇷 and 🇯🇵 languages.
No credit card required • Free forever up to 5 guides