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…

  • OsrsNeedsF2P@lemmy.ml
    5·
    1 year ago

    While we’re at it, I love that you let me customize the settings via a config, but for the love of god make the default config the best it can possibly be

    • The Hobbyist@lemmy.zip
      3·
      1 year ago

      This. It should be the most sane configuration and fit most use cases and lead to an experience working out of the box.

      • charliespider@lemmy.ca
        1·
        1 year ago

        I contribute to OS projects and work on one full time. EVERYBODY thinks that their obscure use case is the most common (not saying this is what you are doing).

        We get users that are completely flabbergasted that our software doesn’t offer some feature that is totally specific to their industry and has never been requested even once by anyone else previously. We’ll show them our feature request form on our site where you can also view and upvote other requests, and point out that the feature they want has never been requested. They will literally come up with some bs excuse why that is and then insist that we get on it and build out this custom functionality that they need or else they’re going to slander us on social media.

        Your app doesn’t integrate with “didLr”? OMG any decent app integrates with “didLr”!

  • noodle@feddit.uk
    3·
    1 year ago

    Sometimes I’d settled for a simple description of what the tool even is. Sometimes the readme is just straight into compilation steps and I feel like we’re rushing into something.

  • TCB13@lemmy.worldEnglish
    1·
    1 year ago

    Dear open source app user: feel free to improve the README file of the projects you come across by adding a few screenshots you believe are relevant.

  • maudefi@lemm.ee
    0·
    1 year 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
      1·
      1 year 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

  • emergencyfood@sh.itjust.works
    0·
    1 year ago

    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.

  • CrabAndBroom@lemmy.ml
    0·
    1 year ago

    Also please begin the Github page or whatever with a description of what the app is actually for or what it does. I know that sounds super obvious, but the number of times I’ve seen links that are like “I made this app from scratch for fun, let me know what you think!” and then you click through and the app is called Scrooblarr or something and it has no indication of what it actually does is… more than it should be.