Ask HN: How do I improve boring README page?
1–10 of 77 posts
Re: Ask HN: How do I improve boring README page?
#2Re: Ask HN: How do I improve boring README page?
#3It 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
Re: Ask HN: How do I improve boring README page?
#4Re: Ask HN: How do I improve boring README page?
#5When 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?
#6If 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?
#7Re: Ask HN: How do I improve boring README page?
#8Re: Ask HN: How do I improve boring README page?
#9Re: Ask HN: How do I improve boring README page?
#10I wrote much more deeply about this on my blog: https://skerritt.blog/make-popular-open-source-projects/