Tribo icon indicating copy to clipboard operation
Tribo copied to clipboard

Developer documentation

Open CarterA opened this issue 13 years ago • 2 comments

We need documentation for end-users, but we also need documentation for developers. Tribo is meant to be open and accessible for hackers, so an overview of the architecture of the whole system would be helpful. I don't think we necessarily need Doxygen-style documentation for every single method of every single class, but getting oriented in a project with zero documentation can be tough.

Developer documentation would also include information about the file format, how templates are set up, and how you could write import and export scripts.

CarterA avatar Feb 16 '12 03:02 CarterA

Also, an up-to-date object dependency graph would be handy. Even better if it had explanations added in.

sgoodwin avatar Feb 16 '12 03:02 sgoodwin

Yep. A good run through objc-deps and a lot of cleanup in OmniGraffle would do us a lot of good.

CarterA avatar Feb 16 '12 04:02 CarterA