4 ms·
I'd be interested in some of your insights into how to make a good README. You only included it under Open Source Documentation, but I believe a good README is
by kykemanuel 3y ago
I'd be interested in some of your insights into how to make a good README.
You only included it under Open Source Documentation, but I believe a good README is mandatory for internal commercial projects as well.
Your effective examples section is great and something I will refer to myself for a while. Thanks!
- zerojames 3y agoI started writing about READMEs a while ago but my writing on the topic is not polished. If you are curious, my notes are here: https://capjamesg.github.io/python-packaging-best-practices/readmes/ https://capjamesg.github.io/python-packaging-best-practices/... Happy to elaborate as necessary!