Shawn Powers wrote:
> Hey, [EMAIL PROTECTED] remember when you typed:
>> That is our biggest problem. We like to code. We add something,
>> announce it to the list. Some stuff big enough finds it's way to the
>> WiKi. But we are missing some _real_ documentation, with all features
>
> In a large "foot in the mouth" venture, I now see the virtue of the wiki.
> :) I have never liked wikis, but darn it -- it sure is good in this
> situation. Here are my current thoughts:
>
> I have started reading some python books. Realize my mind often doesn't
> work like a programmer, but I want to be able to read some code and
> follow what's happening. I had no idea what *happened* when freevo ran.
> I've been looking in the code and trying to figure stuff out. (I've
> added a few minimal things to the wiki, and will continue to add more as
> I figure stuff out)
That's great. But even with the WiKi online, I still want structured
documentation, online and offline. The 'Freevo Installation HOWTO'
from Joseph C. Stump is a very good start, I will add it to the next
release (the CVS only contains the sgml file)
I also would like to have a plugin document: what plugins exists in
Freevo and how to use them. And a plugin HOWTO for developer how to
write a plugin. The first needs some Framework and evey plugin
developer could add some small description, the later needs to be
written by a developer.
> To be honest, I don't *want* you guys to document stuff. Code, code,
> code, code!!! I am trying to learn enough to understand what is
> happening. I'm going to try to look at some more freevo code, and
> document the particularly thin parts. What needs documentation the most
> right now?
Very basic stuff. Mostly the new stuff from CVS. How do plugins work?
What is the new event system and how to change it? What keys are
there? All about fxd files, etc.
> (Oh, and please keep commenting code when possible, especially if
> I'll be perusing it to try wikiing out some documentation)
Sure. I hate it when there is a bug and I don't know what this
function does. So basic doc inside the code is necessary.
Dischi
--
What happens if a big asteroid hits the Earth? Judging from realistic
simulations involving a sledge hammer and a common laboratory frog, we
can assume it will be pretty bad.
-- Dave Barry
-------------------------------------------------------
This SF.Net email is sponsored by: INetU
Attention Web Developers & Consultants: Become An INetU Hosting Partner.
Refer Dedicated Servers. We Manage Them. You Get 10% Monthly Commission!
INetU Dedicated Managed Hosting http://www.inetu.net/partner/index.php
_______________________________________________
Freevo-users mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/freevo-users
