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 │ │ └── ... │ │ └── ...
Some comments have been hidden by the post's author - find out more
Are you sure you want to hide this comment? It will become hidden in your post, but will still be visible via the comment's permalink.
Hide child comments as well
Confirm
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
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: