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…

  • @[email protected]
    link
    fedilink
    9910 months 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.

    • Shadow
      link
      fedilink
      32
      edit-2
      10 months ago

      Foreplay is important! Gotta get me excited for that app.

      • @[email protected]
        link
        fedilink
        17
        edit-2
        10 months ago

        🛠️ Building

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

        make child
        
    • @[email protected]
      link
      fedilink
      English
      1210 months 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

      • @kite
        link
        810 months ago

        I also hate it when it has a name that is a super common word or phrase. Our last 3 records management prograns at work have been like this, and their help fires are terrible to non existent. Good like trying to search the internet for information on the software with those common names. Even adding terms relevant to what the software does, didn’t help much.

        (Apologies if this is terribly typed, I’ve got an impending migraine aura that stayed right as I hit reply and have lost a good chunk of my vision. I can’t see most of what I’m saying.)

        • 𝕸𝖔𝖘𝖘
          link
          fedilink
          English
          510 months ago

          Unrelated, but I used to get them often. I found one article about vitamin D deficiency as a potential cause, and figured, “what what hell”. Started taking 5000IU every day of the Swanson’s brand. It took a month or so, but I’ve been aura migraine free for months (still get migraines sometimes, but they’re MUCH less severe than they used to be and no auras). Ask your doctor first, in case you can’t take vitamin D, but it’s worth a try if it’s safe for you.

          • @kite
            link
            310 months ago

            I actually know what causes most of mine, there are some nerves in my neck that get pinched/aggravated and trigger them. And for some reason, if I have multiple days in a row where I don’t get much sleep, those nerves get extra cranky. They are extra cranky right now.

            • 𝕸𝖔𝖘𝖘
              link
              fedilink
              English
              210 months ago

              I’m so so sorry! I guess, at lease, you know why. That’s something, right? Not really, but :shrug: seriously, I’m so sorry you’re going through that!