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
    72·
    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.

      • QuazarOmega@lemy.lol
        14·
        1 year ago

        🛠️ Building

        To build the app install the gamete dependencies and run the following

        make child
    • Nioxic@lemmy.dbzer0.comEnglish
      8·
      1 year ago

      A lot of documentation is like that.

      Its terrible when the software is called some random word that has nothing to do with the programs functionality