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…

  • maudefi@lemm.ee
    link
    fedilink
    arrow-up
    10
    arrow-down
    8
    ·
    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
      link
      fedilink
      arrow-up
      10
      arrow-down
      3
      ·
      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