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 23 points 1 year ago (3 children)

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 25 points 1 year ago (1 children)

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 9 points 1 year ago (2 children)

Just like obsidian.md

[–] Anafabula@discuss.tchncs.de 9 points 1 year ago

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

[–] Pyroglyph@lemmy.world 3 points 1 year ago

And Lemmy!

[–] GlenTheFrog@lemmy.ml 15 points 1 year ago

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

[–] OfficerBribe@lemm.ee 5 points 1 year ago

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