Hacker News new | ask | show | jobs
by Zarathruster 4 days ago
If we're fair, this is one of the better examples. It looked reasonably useful until it got to the 'CI / GitHub Actions' section. Many readmes take a very long time to describe anything useful, like how to get started or even what exactly the software is.
1 comments

Yeah I was expecting some giant text dump based on the complaints in the comments here, yet all I see is a pretty normal README? It's not even that large.

If we are splitting hairs some sections could have been left out or broken up into a dedicated doc, but this is still vastly better than a README that explains too little. At minimum I expect a README to give me guidance on what this is and how to get started with it and having stuff like a file layout helps with exactly that.