3 ms·
Generally so you don't have to update the README every time you update the source.
by ben509 6y ago
Generally so you don't have to update the README every time you update the source.
- karmakaze 6y agoI wasn't suggesting that the actual code be in the README--that was laziness on my part--more in terms of what's used and expected output characteristics. I would specifically want to know if I was using a library with a certain implementation, changed how it did its main thing in a potentially meaningful way (e.g. dependencies, formulas, character set, output length, etc). A README is a good place to document these points.
- ben509 6y agoFair enough. If it's bugged you enough to think through what you're looking for in a README, that'd be a good post for HN.