DEV Community

Discussion on: How to write a kickass README

Collapse
 
willvincent profile image
Will Vincent

I think if you've got enough info to warrant a TOC, that should follow the initial intro section of the document that describes what the thing is, etc.. AND, that's probably a good time to also think about splitting it into multiple files, ie: instead of a contributors section, a separate contributors.md file, etc.

Thread Thread
 
benracicot profile image
Ben Racicot

+1 this is what I did. Once it gets to a certain length ah... you kind of need one up top.