Live data from Hacker News

Ask HN: How do I improve boring README page?

news.ycombinator.com

1–10 of 77 posts

Ask HN: How do I improve boring README page?

#1
Hello HN, As one of the managers of apache/incubator-age repository, I'm trying to figure out ways I can do to improve the README section. I think I need more images that can show what kind of project we're dealing with, but I'm not sure if that's the main priority for this case. What do you all think this README page need? What does a good README page require?

Re: Ask HN: How do I improve boring README page?

#3
Personally I'd like to see a quick start guide e.g. [1] shows me the bare minimum code needed to get it to work. I'm not a fan of projects that simply use one-liners like `docker run [link]` because it tells me nothing about what I (a developer) will see in my potential future workflow.

It would also be nice to see a comparison (performance, ease of use, etc.) with other frameworks on why I should use it vs whatever else comes up on Google

[1] https://github.com/konvajs/konva#quick-look

Re: Ask HN: How do I improve boring README page?

#5
A suggestion: keep stuff boring.

When one is stuck on a problem, maybe with the deadline or angry boss axe pending on her head, last thing she needs is fancy stuff, emojis, gifa or having to sort through marketing crap (not your case but I've seen plenty of those in "fancy projects")

Look at manpages, emergency operation manuals, medical procedures and copy the style

Use the website for fancy stuff, it's what's its for

Personally the link you shared is perfect to me, at a glance

Re: Ask HN: How do I improve boring README page?

#6
For a project like this, I'm not sure that 'boring' is a bad thing. There's a link to documentation and relatively little fluff. In my game development repo's, I have an image, because it's reasonable to judge a game by it's visuals.

If diagrams (like those produced by draw.io) could be used to better communicate how incubator-age functions and why it is important, you could use them, but I don't think you need to.

An explanation of repo architecture could be useful for people wanting to hack on it. [1]

[1] https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html

Edit: Just noticed the Documentation section doesn't link to the website. If I'm getting started with your project, the getting started documentation on your website will be far more useful to me than a very long PDF.

Re: Ask HN: How do I improve boring README page?

#9
May I kindly ask any developer, who sets up a webpage, to have at least a single paragraph of an introduction, what the software is supposed to do? Admittedly, it happens very seldom, but it does: Documentation, that goes straight to the usage, without any intro as what the software is.

Re: Ask HN: How do I improve boring README page?

#10
Hey! I have around ~15k GitHub stars and am generally known for nice READMEs. My 3 biggest tips are: 1. Show what you do (better yet: let the user use your software) 2. Show how you're better than competitors (feature comparison) 3. Network effect (thanking contribs, people, other projects etc)

I wrote much more deeply about this on my blog: https://skerritt.blog/make-popular-open-source-projects/

Post reply on HN