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…

  • noodle@feddit.uk
    1·
    3 years 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.

  • leraje@lemmy.worldEnglish
    1·
    3 years ago

    Also, installation instructions that don’t assume you’re already an expert.

  • Random Dent@lemmy.ml
    1·
    3 years 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.

  • TCB13@lemmy.worldEnglish
    1·
    3 years 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.

  • OsrsNeedsF2P@lemmy.ml
    0·
    3 years 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
      1·
      3 years ago

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