1197
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
[-] herrvogel@lemmy.world 27 points 1 year ago

If you've written a "usage" section that showcases more than one uselessly simple example that doesn't even work in the project's current state, you're already far ahead of the average.

[-] CombatWombatEsq@lemmy.world 2 points 1 year ago

This is how I generally write documentation for my projects: https://tybalt.org

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

Open Source

29688 readers
60 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