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…

  • CoderKat@lemm.ee
    link
    fedilink
    English
    arrow-up
    11
    arrow-down
    1
    ·
    edit-2
    1 year ago

    Even for a CLI tool, there should be a real world example showing how it works and what the output looks like. Eg, for jq:

    $ cat file.json
    {"field: "value"}
    $ jq '.field' file.json
    "value"
    

    And a few other examples.