Hey'

That's great!  I had just offerred my services and sent a patch to guruz
yesterday with some htdocs proofreading but I can see you're much more
qualified.  Ahh, if there's one thing better than scratching an itch, it's
having someone else do it for you.  Anyway, let me know if you need help
of any kind.  I guess gtkg has reached that free software critical mass
where the  lonely developers finally start getting some help.  Feel free
to send me material to proof-read or just post to devel when you commit to
cvs and I'll check it out.  

As far as what's needed, I'd say the first thing to tackle (on the user
end) would be the README in the dist and the manpage since these are
what's generally installed on the system.  The README is, for those of us
who read the docs, the first thing we read after we are convinced to
download by freshmeat | webpage.  At that point, it's the README that
determines whether I'm going to actually compile the sucker and check it
out.  I want the README (or INSTALL) to tell me what any gtkg specific
./configure options are all about - I had to browse the cvs to figure out
what that shell option was all about.  I guess the logical (traditional)
structure for the README would be intro, compile, install, use, further
info and pointers.  

The manpage is the first place (theoretically) that people seek help and I
think those that are actually willing to read it and help themselves
should be rewarded by its usefullness.  Openbsd users will be especially
thankful that they will be able tell newbies "man gtk-gnutella, jerk!"  I
was going to start playing with this, myself.  

I think source for all other docs (including the web page) should be in
sgml/xml format so they can be converted to other formats.  Linuxdoc or
whatever.  The separation of content from presentation will really help
potential translators.  Help pages that involve screenshots, etc will much
easier to upgrade when the gui changes.  

I guess you'll need to do documentation on the developer end before all
this, since that's what the user docs will be based on.  

Anyway, thanks and let know how I can help.  

--
Murphy (eqom14 on irc.freenode.net) 


-------------------------------------------------------
This SF.net email is sponsored by: Scholarships for Techies!
Can't afford IT training? All 2003 ictp students receive scholarships.
Get hands-on training in Microsoft, Cisco, Sun, Linux/UNIX, and more.
www.ictp.com/training/sourceforge.asp
_______________________________________________
Gtk-gnutella-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/gtk-gnutella-devel

Reply via email to