Start working in documentation #8
Description
Right now this codebase is self-documenting, basically because I didn't (and currently don't) have time to invest in documenting this library
The current project structure is simple enough that anybody could at least write what the main functions do, and that would be great for new users
I ain't gonna do it, so you might help me as well
TODO
- Define where and how to host the documentation
- Write documentation for the first functions any user will need trel_init... and trel_free...
- Write documentation for the structs, their values and what should or shouldn't be modified
- If you have reached this point, you know better than me what needs to be documented