This is going to be the documentation style for documentation for application developers who are building an E-mail client on top of tinymail.
I already wrote about the importance of documentation when doing a library or framework like tinymail. I would like to add that without it, the entire piece of software has the same value as vaporware for a lot of software developers and companies who would otherwise be very interested in using it. Why am I telling you this? Because I want to stress the importance of documentation in the tinymail project to future contributors. I would like to set the standard for the documentation of the project early and high.
A first mini tutorial explains how to get a list of accounts in a TnyGtkAccountListModel and how to set that as a model for a GtkComboBox. A second explains how to display folders in a GtkTreeView.
- Showing accounts, a first application developer tutorial for tinymail;
- Showing folder stores, a second application developer tutorial for tinymail.
I hope that while I will probably be writing most of those documents myself , people will read it and make improvements and for example language and code-style corrections. It’s wiki style (trac), so everybody can edit this. I don’t know how fast the list of tutorials will grow. I’m a bit fanatic about documentation, so I guess that “a few weeks” is going to be a doable timeframe.
It’s not much yet. But hey, you can help and by doing that it will drastically speedup (more than 100% faster, because you putting energy in it, would inspire me to work on it faster too).
Yes, I know that I’m insane and that I want to do too much at the same time. In dutch we have a saying that goes like “zot zijn is gezond”. It translates to: “being a nut is healthy”.