kilon / morpheas

Morpheas is a GUI API for the construction of custom guis using skins, actively supporting blender and based on OpenGL
GNU General Public License v3.0
9 stars 4 forks source link

Separate documentation for Morpheas #8

Closed kilon closed 6 years ago

kilon commented 6 years ago

When I started the project I made the decision to not include a separate documentation and instead document the code via code comments. This is a good tactic that I will continue to make it easy for people to understand the internals of Morpheas but the more complex Morpheas becomes the more necessary will become also the need for separate documentation and is a good idea to start now that is early instead of much later on. Ideally documentation must be part of this repo so maybe Markdown may be more than enough because its supported by Github but also can be used for the creation of PDFs, readthedocs is also another good alternative.