1220
submitted 2 years ago* (last edited 2 years 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....

(page 2) 50 comments
sorted by: hot top controversial new old
[-] Gallardo994@lemmy.world 15 points 2 years ago

To be fair, most of time you can just Google %appname% screenshot. I understand that this is not as convenient as having screenshots in the readme, but eh, it's not as big of a problem when you realize this.

P.S. I do actually add at least one screenshot for my software. Maybe because sometimes UI is one of the main focus, idk. I just feel like it.

[-] CoderKat@lemm.ee 6 points 2 years ago

I think that doesn't work for most smaller projects. That'll work for something like Firefox, but there's little reason for random, unheard of tools to have an image on the web. Plus the naming of some projects is super generic, which can make it hard to find correct images.

Some software changes appearance often, too, and google is bad at knowing what up to date is. It can be really easy to find wildly out of date images as the top results.

load more comments (2 replies)
[-] SpacePirate@lemmy.ml 15 points 2 years ago

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.

load more comments (6 replies)
[-] Secret300@sh.itjust.works 11 points 2 years ago

Dear Open source devs: Do something I'm too lazy to contribute.

[-] shapis@lemmy.ml 9 points 2 years ago

Unironically yes. Asking someone that doesn't use your project, isn't part of the development, and quite possibly doesn't even want anything to do with your project to do work for you project is silly.

[-] iegod@lemm.ee 6 points 2 years ago

I mean, it's just a suggestion. The utility depends on the goal of the project. Am I being lazy? Don't care. Do I want maximum user engagement/feedback; well, the suggestion is sound.

[-] maudefi@lemm.ee 10 points 2 years ago

No. ReadMe files should be concise, explicit, and text only. UI/UX screenshots can be part of the repo, wiki, or associated website but they shouldn't be in the ReadMe.

If you don't understand the software you're installing from some rando stranger's git repo then you shouldn't install it. Period. Take the opportunity to learn more or use another tool.

Git repos are not app stores. The devs don't owe you anything.

The vast majority of software in publicly accessible git repos are personal projects, hobbies, and one-off experiments.

Your relationship with the software and the devs that create and maintain it is your responsibility. Try talking to the devs, ask them questions, attempt to understand why they constructed their project in whatever specific way they have. You might make some new friends, or learn something really interesting. And if you encounter rudeness, hostility, or incompetence you're free to move on, such is the nature of our ever-evolving open-source community.

We bring a lot of preconceived notions into the open-source / foss / software development space as we embark on our own journey of personal development. I try to always remember it's the journey of discovery and the relationships we curate along the way that is the real prize.

[-] hellishharlot@programming.dev 10 points 2 years ago

For a lot of open source at the moment the root level readme is fundamentally the homepage too. It absolutely should include screenshots, maybe even a gif. If your software has a GUI or TUI it should follow that a concise visual will do more to explain it's usage than a text document

[-] johannes@lemmy.jhjacobs.nl 9 points 2 years ago

Who reads README's anyway? Aren't they like instruction manuals? You only read them once its broken? :) Or maybe i should start reading instruction manuals..

[-] Pechente@feddit.de 12 points 2 years ago

Lots of projects are on GitHub or similar repositories and the landing page is usually the readme file as rendered markdown.

load more comments (3 replies)
[-] Winn_Addison@lemmy.ml 8 points 2 years ago

TURE...👍

[-] 13@calckey.world 8 points 2 years ago

Where should I store the screenshots? In a screenshots folder in the repo? Should I update them at some time? Should I screenshot both light and dark theme?

[-] moritz@lemmy.deltaa.xyz 10 points 2 years ago

Where: In the repository, most projects seem to use media or screenshots as the name of the directory.

How often: Whenever a big change happened or many small changes have accumulated.

What: Light theme suffices. I only care about the general look and feel, not about specific colors.

That’s how I would do it for my own projects.

load more comments (1 replies)
[-] xamboni@lemm.ee 9 points 2 years ago* (last edited 2 years ago)

That’s one option, or use imgur.

Update them if your UI has significantly changed or does not adequately represent the final product.

If having a light/dark theme is an important feature or highly requested feature for your project, it would be nice to show it off.

Screenshots can, most of the time, get away with showing just the default configuration. Share what a user would see when opening your project for the first time, and assume they used the default configuration. Optionally, if you offer a lot of customization, show what it could look like if someone spent a good amount of time personalizing things!

[-] jelloeater85@lemmy.world 10 points 2 years ago

Please don't use a external image host, have it live with your code in /docs

[-] CoderKat@lemm.ee 8 points 2 years ago

Yes. Git can store binary files fine. It's not the most efficient for storing them, but it works, especially for a small number of screenshots. For updating and theme, that's entirely up to you. It's all a judgement call. If you want to show off your functionality (like a dark mode), I encourage you to include screenshots of it. If you substantially change your UI, update the images.

You don't have to update for every new button you add. It's more about giving a general impression of the UI. Is it minimalist? Is it a chaotic mess? Does it look like it fits in naturally with whatever OS appears to have been used? Does it look like any thought was put into UI and UX? Those are the kinds of things you're trying to answer.

[-] vacuumflower@lemmy.sdf.org 7 points 2 years ago

A README file is usually comprised of text.

Other than that - usually if it has a webpage, it has some screenshots.

load more comments (1 replies)
[-] praeceptorem666@relyma.club 7 points 2 years ago

Too lazy to just look the UI up and you want others to waste their time giving you numerous UI screenshots. Hypocrite

[-] s20@lemmy.ml 11 points 2 years ago* (last edited 2 years ago)

a.) I'm not convinced you know what the word hypocrite means.

b.) More importantly, they didn't ask for "numerous," they asked for one.

c.) Searching for the UI on, say Google, can have, at best, mixed results. Ive done this, then DLed and tried out the program only to find a completely different UI.

d.) The dev adding one screenshot to their readme.md and a /media folder takes them only slightly longer than it takes potential users to look one up and maybe get a good result. Multiply that time by the number of potential users, and it's obviously more efficient, and effective, for the dev to do it.

Stop being defensive. No one's attacking you or any other dev. They're making a request. Don't like it? Don't do it. Stop calling people names and trying to stir up drama.

Edit: formatting

load more comments (10 replies)
[-] flop_leash_973@lemmy.world 7 points 2 years ago

Don't forget to assume what works on macOS also will work fine on a Linux server deployment.

load more comments
view more: ‹ prev next ›
this post was submitted on 14 Aug 2023
1220 points (100.0% liked)

Open Source

35453 readers
317 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