1220
submitted 2 years ago* (last edited 2 years 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....

(page 3) 42 comments
sorted by: hot top controversial new old
[-] andruid@lemmy.ml 4 points 2 years ago

Anyone know of good Gitlab CI or GitHub actions for auto generating GUI screenshots and links them in the README? I only barely know testing tool and frameworks like OpenQA and Robot for GUI. Even better if we can get AVIF/GIF linked in there to see an app in motion.

Honestly though, documenting is a pain enough, I really don't want to be doing screenshot walk throughs on anything I'm not paid to do.

[-] MonkderZweite@feddit.ch 3 points 2 years ago

I prefer install instructions. Not everything is in AUR.

[-] shaked_coffee@feddit.it 2 points 2 years ago

I totally agree that screenshots and a proper description of the app in the README are a must-have for all foss apps, but as a developer I know that most of the times you prefer use your time to add new features to your app rather then documenting existing ones...

Personally I'll try to add them to all my future projects but what I would suggest to everyone who use and love a foss app is to check out its README and, if needed, submit a pull request with an updated version of it with screenshot etc (You don't need to be a developer to do that and it can be really appreciated)

[-] SwingingTheLamp@midwest.social 1 points 2 years ago

Hey, all you folks ought to get together and publish a guide to writing good FOSS documentation,

load more comments
view more: ‹ prev next ›
this post was submitted on 14 Aug 2023
1220 points (100.0% liked)

Open Source

35453 readers
255 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