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…
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
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.
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
Foreplay is important! Gotta get me excited for that app.
🛠️ Building
To build the app install the
gamete
dependencies and run the followingmake child
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.