Hacker News Reader

I disagree. Users, not just maintainers, discover projects through GitHub. In this context, the README effectively serves as a secondary project landing page. IMO, for a visual project like this, images, or a direct link to images, is a must.

View on HN

Then a link to the website which is a much better medium for demonstrating software than README files would be a simple fix.

Then a link to an example image on the web site is much better.

The idea is to help people understand the project. Not to give them an investigation task. I don’t know the structure of that web site or if there are even images there.

The first time in your life that you learn that a project's code lives on GitHub and its documentation and marketing website are someplace else, you'll start looking for the website reference in the GitHub README or searching for it as a matter of course. It's really not that big a deal.

It’s not a big deal. It’s just a useful piece of documentation.

I’m not heartbroken because of this gap, I’m just confused why they wouldn’t want to add these docs to help users.

Reply on news.ycombinator.com