Skip to content

README template

The required shape of every README file.

The template

# {Title}

> {scope description}

## Contents
| File | Description |
|---|---|
| [File Title 1](./file1.md) | TODO |
| [File Title 2](./file2.md) | TODO |
| [File Title 3](./file3.md) | TODO |
| [File Title 4](./file4.md) | TODO |