Hi there guys, I have two projects that I want to share on github and I was wondering what would be a good way to organize the project. Both projects are in C.
In the last days I have:
- Hidden the implementations that should be hidden.
- Improved the Makefile (for instance, it adds the -g flag when compiling).
- Created a .gitignore file.
I am still thinking if that is enough. What do you guys expect when you clone a github repository? Should I add some samples or the tests?
If you want other people to use you work, it is really useful to version and tag the code (http://semver.org) so your users have some way to understand what kind of changes they could be pulling down. Also make sure that you have a readme and that it tell me how to build and test your code, as well as what dependencies you have.