I added an execution command to the readme. Java is not my primary language and I know how to run a jar but I think it would be helpful to newer people to have just a line showing how to execute the jar from terminal.
In general, lots of documentation on projects leave these details out and I think it is treated as if you do not know how to execute this, then maybe you should not be running it. I contest that because I commonly will try to run a project first, then dive deeper. This lack of execution tutorials in documentation I think is a unnecessary barrier of entry.
Not to say any of this is reflective on your project, I am just ranting why I think this line of documentation is important. :)
I added an execution command to the readme. Java is not my primary language and I know how to run a jar but I think it would be helpful to newer people to have just a line showing how to execute the jar from terminal.
In general, lots of documentation on projects leave these details out and I think it is treated as if you do not know how to execute this, then maybe you should not be running it. I contest that because I commonly will try to run a project first, then dive deeper. This lack of execution tutorials in documentation I think is a unnecessary barrier of entry.
Not to say any of this is reflective on your project, I am just ranting why I think this line of documentation is important. :)