this post was submitted on 14 Aug 2023
1192 points (97.8% liked)

Open Source

31358 readers
180 users here now

All about open source! Feel free to ask questions, and share news, and interesting stuff!

Useful Links

Rules

Related Communities

Community icon from opensource.org, but we are not affiliated with them.

founded 5 years ago
MODERATORS
 

I beg you, if you are a developer of an open source app or program - add screenshots of your app to the README file. When looking for the perfect app, I had to install dozens of them just to see what the user interface looked like and whether it suits me. This will allow users to decide if the app they choose will suit them... Please, don't think about it, just do it....

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 43 points 1 year ago (1 children)

So why not add a 'Screenshots' section with hyperlinks to PNG files?

[–] [email protected] 30 points 1 year ago (1 children)

Or, hell, just add a "screenshots" folder to the repo and mention its existence in the readme.

[–] [email protected] 10 points 1 year ago (2 children)

The best solution is to create an issue and attach the pictures there. You can then link in README and not bloat the repository.

[–] [email protected] 5 points 1 year ago

If I clone the repo I expect everything to work, including the readme.

[–] [email protected] 1 points 1 year ago

That's a good point non-text shouldn't be in the git tree, git-lfs is another solution for that though