3 ms·
I think READMEs should be kept as simple as possible. They should remain compatible/functional with terminal output, and they shouldn't have dependencies. But
by kowlo 6y ago
I think READMEs should be kept as simple as possible. They should remain compatible/functional with terminal output, and they shouldn't have dependencies.
But I also think many READMEs could be improved with the inclusion of a figure or two.
It really helps if the artefact has some kind of visual output, and if there isn't, some kind of diagram could be useful.