Well, I actually started writing something finally. I wrote a bit of
documentation a little over a year ago, but I was creating DocBook source
freehand and couldn't get the thing to validate, so I thought it would be better
to start afresh.
What I'm going to do to start with is write what I'm calling "The ZooLib
Cookbook", which will explain each of the demo programs in detail. So far we
only have two demos, ZHelloWorld and ButtonMessage, but I plan to write more,
eventually with one program to illustrate each important concept in building a
ZooLib application, and then something larger that ties it all together. Then
I'll write a programmer's manual, but I think it's more useful to write the
cookbook first as we will also be able to document ZooLib's API using Doxygen
(kind of like Javadoc but for C++).
You can see my first timid steps at:
http://goingware.com/zoolib/cookbook/
I'll put updates there regularly until I have something that is at least mostly
complete and coherent, then I'll post it at the sourceforge site. Soon I will
also check the XML document source into CVS at sourceforge also.
I thought it would be nice to show you tonights first bit of work so you can see
what it looks like. I particularly like how quoted source code is formatted
with the gray box around it.
As you will see I'm releasing it under the GNU Free Documentation License. You
can find out more about the FDL at:
http://www.gnu.org/licenses/licenses.html#FDL
Note that ZooLib itself is released under the MIT license, not the GPL. Doing
that enables writers of commercial software to use ZooLib without releasing your
own source code. But the programmer's manuals won't be part of your products,
and I think the Free Software Foundation (most likely RMS) makes a pretty good
case for using licenses like the FDL in "Free Software and Free Manuals" at:
http://www.gnu.org/philosophy/free-doc.html
I'm only going to be able to work on the doc sporadically so don't hold your
breath waiting for it yet. As always the best way at present to learn how to
use ZooLib is to read the sample source code and ask questions on the mailing list.
Mike
--
Michael D. Crawford
GoingWare Inc. - Expert Software Development and Consulting
http://www.goingware.com
cra...@go...
Tilting at Windmills for a Better Tomorrow.
"I give you this one rule of conduct. Do what you will, but speak
out always. Be shunned, be hated, be ridiculed, be scared,
be in doubt, but don't be gagged."
-- John J. Chapman, "Make a Bonfire of Your Reputations"
http://www.goingware.com/reputation/
|
