Discussion

Ask HN: What makes a README file awesome?

I recently read many thoughts on how to write a README file -- the most important part of a repo? -- and I'd love to have the opinion of the community here.

What makes a README file awesome from your point of view? What are the key elements you'd expect when reading one? Any good example?

And by 'awesome,' I mean a file that's resourceful and makes you want to contribute.

Thanks :)

6 points fmerian 3 years ago 9 comments

Discussion

Live from the official Hacker News API

A modern reader for Hacker News · SvelteKit + Skeleton