this post was submitted on 14 Aug 2023
1197 points (97.8% liked)
Open Source
31373 readers
49 users here now
All about open source! Feel free to ask questions, and share news, and interesting stuff!
Useful Links
- Open Source Initiative
- Free Software Foundation
- Electronic Frontier Foundation
- Software Freedom Conservancy
- It's FOSS
- Android FOSS Apps Megathread
Rules
- Posts must be relevant to the open source ideology
- No NSFW content
- No hate speech, bigotry, etc
Related Communities
- !libre_culture@lemmy.ml
- !libre_software@lemmy.ml
- !libre_hardware@lemmy.ml
- !linux@lemmy.ml
- !technology@lemmy.ml
Community icon from opensource.org, but we are not affiliated with them.
founded 5 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
While I get the sentiment, historically, readmes have been text only, and should predominately focus on usage options, not a sales pitch. Today in GitHub, these files support markdown, but the level of effort is probably two orders of magnitude higher than a text readme alone.
Think of a readme file on GitHub/distributed with the binary more as a man page than a proper website.
So why not add a 'Screenshots' section with hyperlinks to PNG files?
Or, hell, just add a "screenshots" folder to the repo and mention its existence in the readme.
The best solution is to create an issue and attach the pictures there. You can then link in README and not bloat the repository.
If I clone the repo I expect everything to work, including the readme.
That's a good point non-text shouldn't be in the git tree, git-lfs is another solution for that though