XilefTech/CharlieOSX

Documentation not existent

XilefTech opened this issue · 3 comments

I'm aware that there is almost no documentation in and around the code except for the config file.

At the moment I'm concentrating on getting basic functionality for all robot types with the number codes working.
When I'm finished with that I'll do the documentation for the hole Project.

I hope you can understand that.

Will this ever happen?

Sure
At the moment I'm focusing on bringing the basic functionality to CharlieOSX. I think I got most done by the end of next week and then, I'll probably do at least some of the documentation

@TheGreyDiamond I now created a wiki here in this repo. It should contain most information about CharlieOSX, but I am still working on it. If I totally missed some point in there, let me know (except the method usage in the class documentationm I am aware of that one and will add it soon)

Also the Documentation in-code with comments etc. is following soonTM