I would recommend the following update for the README.md. This might be the only part the reviewer (different to the actual end user) look at. Let's use this as a showcase!
Therefore, you want to describe the purpose and potential output for the programming at beginning.
Generally, people put the installation section before the usage section. However, I would like to move usage and example higher up, incase the reviewers never got a chance to see it.
In the example output section, treat this as a short demo or showcase of your program.
Generally, the coding is pretty good already, I will show you a few things to make your life easier in the future.
I would recommend the following update for the
README.md
. This might be the only part the reviewer (different to the actual end user) look at. Let's use this as a showcase!installation
section before theusage
section. However, I would like to moveusage
andexample
higher up, incase the reviewers never got a chance to see it.Generally, the coding is pretty good already, I will show you a few things to make your life easier in the future.