1203
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
[-] emergencyfood@sh.itjust.works 22 points 1 year ago

README is usually a text file. While some platforms can now use markdown, that is nowhere near universal. So it might be better to ask for screenshots to be put on the website / wiki.

[-] FrostySpectacles@lemmy.ml 27 points 1 year ago

GitHub and GitLab both support inserting images into your README.md. Here's the syntax:

![Description of the image](https://path/to/image)
[-] Nioxic@lemmy.dbzer0.com 10 points 1 year ago
[-] Anafabula@discuss.tchncs.de 10 points 1 year ago

And anything that supports CommonMark. It's even in the original Markdown

[-] Pyroglyph@lemmy.world 3 points 1 year ago
[-] GlenTheFrog@lemmy.ml 16 points 1 year ago

Not just a text file, a markdown file. And markdown has supported images since forever

[-] OfficerBribe@lemm.ee 6 points 1 year ago

README.txt will be a text file, README.md can be much more

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

Open Source

31665 readers
277 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