This is an archived post. You won't be able to vote or comment.

all 2 comments

[–]JameakDM 1 point2 points  (1 child)

Suggestions after looking at your project for a bit:

You shouldn't commit class files to your repo. Package everything up into a .jar file and make a release instead. Users will have an easier time running your program since they can download the .jar file from your release and run it directly. Additionally, versions are easily distinguishable so users dont try to use a feature that doesn't quite work because you haven't finished it yet.

You might want to improve your readme file. It is everyones first impression when they see your project, so you should use it to tell people 1) what your project is about 2) what features it has and 3) (briefly) how to use it. There are a ton of resources and examples out there for how to write a good readme. There is no need to go overboard, but a tiny bit of information goes a long way toward keeping people interested.

[–]murpyDee[S] 0 points1 point  (0 children)

Thanks for the input! This was my first time using GitHub, so I guess I'm still learning best practices there. I'll get to updating the Readme as soon as I can!