3 ms·
I'm not the person you responded to, but I think their peeve stands correct for technical README's as well. I've decided more than once to not continue reading
by Y-bar 6y ago
I'm not the person you responded to, but I think their peeve stands correct for technical README's as well. I've decided more than once to not continue reading those when is is not clear to me to move on to what might be a similar implementation just because the README never really explained if it was what I was looking for.
The times when I need to read the repo README is when I am not familiar with what I am looking for. I say err on the side on more documentation, err on the side of a better explanation.