# README File

> The first file you read in a project. It says what the project is for.

**Field:** Software Development  
**Category:** Product & Releases  
**Also known as:** README, README.md

## Think of it like

Think of it like the sign on a shop door. It tells you what is inside and how to come in.

## Definition

A README is the first file people read in a project, usually called README.md. It says what the project does, how to install it and how to use it, often with a short example. GitHub shows it on the front page of every repo. A good README answers the first questions in under a minute. It is often the only page of docs a small project has.

## Example

Jack opens a new library on GitHub. Its README shows one install line and a short example. He is using it in two minutes.

## Example code

```markdown
# Tiny Dates

Formats dates in one line.

## Install

npm install tiny-dates
```

A title, one line on what it does, and how to install it.

## Why it matters

Most people decide in seconds whether to use a project. The README is what they decide from.

## Common mistake

Leaving the default README that only shows the project name. Visitors leave without knowing what it does.

## Three principles

- **The front door.** First file people read.
- **What, install, use.** The three answers.
- **Shown by GitHub.** On the repo's front page.

## Related terms

- [Software Documentation](https://learn.benibix.com/term/development/documentation)
- [Markdown](https://learn.benibix.com/term/development/markdown)
- [GitHub](https://learn.benibix.com/term/development/github)
- [Changelog](https://learn.benibix.com/term/development/changelog)
- [CONTRIBUTING File](https://learn.benibix.com/term/development/contributing-file)

## Taught in

- [Markdown and Front Matter](https://learn.benibix.com/learn/development-formats/markdown-and-front-matter): File Formats, 7/11

---

Source: https://learn.benibix.com/term/development/readme
Author: Behnia Zarei (a developer in Vienna, Austria, who builds and teaches data, AI and business intelligence at BENIBIX)
Publisher: BENIBIX Learn (https://learn.benibix.com/)
Last updated: 2026-11-17
Licence: CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Quote freely with attribution.
