1202
submitted 1 year ago* (last edited 1 year ago) by mypasswordis1234@lemmy.world to c/opensource@lemmy.ml

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
[-] 13@calckey.world 6 points 1 year ago

Where should I store the screenshots? In a screenshots folder in the repo? Should I update them at some time? Should I screenshot both light and dark theme?

[-] xamboni@lemm.ee 9 points 1 year ago* (last edited 1 year ago)

That’s one option, or use imgur.

Update them if your UI has significantly changed or does not adequately represent the final product.

If having a light/dark theme is an important feature or highly requested feature for your project, it would be nice to show it off.

Screenshots can, most of the time, get away with showing just the default configuration. Share what a user would see when opening your project for the first time, and assume they used the default configuration. Optionally, if you offer a lot of customization, show what it could look like if someone spent a good amount of time personalizing things!

[-] jelloeater85@lemmy.world 10 points 1 year ago

Please don't use a external image host, have it live with your code in /docs

load more comments (3 replies)
this post was submitted on 14 Aug 2023
1202 points (97.8% liked)

Open Source

31028 readers
585 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