Open Source

31385 readers

211 users here now

All about open source! Feel free to ask questions, and share news, and interesting stuff!

Useful Links

Rules

Posts must be relevant to the open source ideology
No NSFW content
No hate speech, bigotry, etc

Related Communities

Community icon from opensource.org, but we are not affiliated with them.

founded 5 years ago

MODERATORS

[email protected]

1203

Open source devs: please, please add screenshots... (lemmy.world)

submitted 1 year ago* (last edited 1 year ago) by [email protected] to c/[email protected]

129 comments fedilink hide all child comments

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

[–] [email protected] 22 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.

[–] [email protected] 27 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)

[–] [email protected] 10 points 1 year ago (2 children)

Just like obsidian.md

[–] [email protected] 10 points 1 year ago

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

[–] [email protected] 3 points 1 year ago

And Lemmy!

[–] [email protected] 16 points 1 year ago

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

[–] [email protected] 6 points 1 year ago

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