Re: [sprog-users] Documentation

[Grant M. <gr...@mc...>]

On Fri, 2005-06-10 at 09:58 +0100, Gavin Brown wrote:
> > If you have feature requests, I'm all ears.  I've got plenty of ideas 
> > to work on, but if you have something in mind that you'd find useful
> > then I definitely want to hear about it.
> 
> Is there a "gear-writing guide"? I have some ideas but don't know where
> to start.

The file lib/Sprog/help/gear_internals.pod contains the information
required to understand gears.  Towards the end of the document it gets
into the specifics of what you need to do to write your own.  If your
gear would need a properties dialog, there's some information about that
in lib/Sprog/help/prop_auto_dialog.pod.

To read those POD files, in addition to the familiar 'perldoc' tool, you
can run Sprog, press F1 for help and then click on the links under the
"Help for Developers" heading.

There are bound to be typos and unclear bits, so let me know if there's
anything you don't understand.

Regards
Grant