Recently I’ve been working on the project documentation. That may not the nicest job for one who loves writing code but I consider it very important! Documentation is surely important for new people to easily get started or old developers to catch up with project development. And yes, it is hard to write good documentation but it is worth the effort at least for one thing – in order to describe what you’ve done you really must understand what you’ve done. Normally, at least with me, trying to write good documentation makes me think about the details of what I have done; makes me try to explain why I’ve done that thing in that specific way; i.e. makes me check my reasoning for bugs. Anything that makes one think is a good thing!

The attached patch contains the new documentation that will soon appear at http://doc.calitko.org. I’ve finally written some more informative text for the index page and have added some other pages about what you need (compiler, Qt, how to install them) in order to build Calitko, how to contribute to the project, what is Calitko’s architecture (still only a placeholder).

A new important part is Calitko Coding Conventions. It explains in short what are (in our understanding) packages, components and objects; and how they should be implemented in C++. The aim of these conventions is mainly to gather and describe some good practices in Calitko development. A secondary aspect of these conventions is to have source code written in the same style. I will write about how I applied the current coding conventions to one Calitko package in my next post.