DEV Community

Cover image for Create A Good README File

Create A Good README File

Ali Samir on February 11, 2024

📌 What is a README file? The README file serves as the initial point of contact for users visiting your repository. It provides an overv...
Read full post
Collapse
 
csituma profile image
Info Comment hidden by post author - thread only accessible via permalink
Clara Situma • • Edited

A good readme, especially in large codebase, should also include Table of Contents or Folder structure.

Including a table of contents helps for quick navigation, especially for long READMEs.

This helps readers jump directly to sections of interest.

Example:

.
├── ...
├── dist
│   ├── themes
│   │   ├── customerName.default.css
│   │   ├── company.default.css 
│   │   └── ...
│   │
│   ├── logos
│   │   ├── customerName.png
│   │   └── ...
│   │
└── ...
Enter fullscreen mode Exit fullscreen mode

Some comments have been hidden by the post's author - find out more