3 ms·
I prefer all-encompassing READMEs over incomplete scattered documentation.
by ricardobeat 15y ago
I prefer all-encompassing READMEs over incomplete scattered documentation.
- stock_toaster 15y agoI think all-in-one-README works well for some things, but some of our projects at work would result in HUUUGE readme files. Not so pleasant if those were a single file. We have started using gollum-site[1] for our stuff that grows beyond a medium size length. The single-long-readme length issue appears to be alleviated by the nav construction in documentup though. Pretty slick. https://github.com/dreverri/gollum-site https://github.com/dreverri/gollum-site