Re: [Bug-gnubg] new manual

[Joern Thyssen]

On Mon, Aug 12, 2002 at 04:10:31PM -0400, Gary Wong wrote
> On Sun, Aug 11, 2002 at 07:22:05PM +0200, Achim Mueller wrote:
> > I just added a new structure for the manual. Take a look at it and
> > suggest improvments. 
> 
> I like the new layout in general, except that I think that installation
> instructions do not belong in the manual.  They certainly should be
> documented somewhere, but I think it would be more appropriate to give
> appropriate instructions along with each distribution (e.g. the Debian
> page comes with its own instructions, Øystein's site documents how
> to install his MS Windows snapshots, etc.)

INSTALL is included in the distribution, so maybe we should just point
to it. Still, it could be nice to include some of the windows specific
stuff so it won't get lost.

> I will work on reworking the old example game to document the GTK+
> interface instead.
> 
> Jørn writes:
> > I assume the documentation primarily should describe the GTK interface.
> 
> Yes, I think so.
> 
> > How do we document the command equivalents to the GUI?
> 
> Unless there are are any better ideas, perhaps we can describe the commands
> and syntax in an appendix or something?

Yes, it thought about that, but we may end up writing the same stuff
twice: both in the GUI reference and in the CLI reference. Perhaps we
should write a CLI reference chapter with minimal descriptions and make
cross-references to the GUI chapter, or vice versa...?!

Jørn

-- 
Joern Thyssen, PhD
Vendsysselgade 3, 3., DK-9000 Aalborg, Denmark
+45 9813 2791 (private) / +45 2077 2689 (mobile) / +45 9633 7036 (work)