3 ms·
Ask HN: Why don’t GitHub readme pages include screenshots?
I frequently come across GitHub projects that don’t include any screenshots and the project will contain UI elements. I’m wondering if there is a reason why so many don’t include screenshots?
For example sidebery[1] didn’t have it. I use it and it’s great but it’s hard to get a sense of what it does Without actually showing a screenshot.
1. https://github.com/mbnuqw/sidebery
- jjgreen 3y agoThe GitHub repo is mainly for devs, there's a link to the addon page there, it seems reasonable that a dev would know to click on it.
- gerimate 3y agoAs someone who's responsible to maintain docs and readmes I try to avoid working with screenshots as there might be some minor UI changes time to time which might be distracting or confusing.
- lgpants 3y agoThat makes sense, I’ve also written a lot of docs and screenshots are a pain to maintain but also users and myself find them so useful.
- devonnull 3y agoAs other commenters posted, maintaining screenshots is a pain. Especially with software that's regularly changing. That said, there are more than a few GitHub readmes that contain screens. Sometimes quite a few screens. Here's an example: https://github.com/gsantner/markor https://github.com/gsantner/markor