Open source devs: please, please add screenshots...
Open source devs: please, please add screenshots...
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're viewing a single thread.
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?
Where: In the repository, most projects seem to use
mediaorscreenshotsas 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.
As an example, an old Android project of mine: https://github.com/moritzruth/JamRSS
I showed one screen in both the light and the dark variant to demonstrate that the app generally has support for dark mode.
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!
Please don't use a external image host, have it live with your code in /docs
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.