From: Ullrich von Bassewitz (uz_at_musoftware.de)
Date: 2003-09-18 11:54:32
On Wed, Sep 17, 2003 at 03:43:42PM -0700, Shawn Jefferson wrote:
> Well, can you suggest a layout for the documentation?
The doc should be in sgml like the others, and all platform specific
documentation should preferably habe the same structure. I can generate a
template for a start.
> Can a lowly
> user of the Atari library like me write up a bunch of stuff that I've
> found out about it?
Why not? People like you are the actual users, so if you answer the questions
you had in this document, it will definitely be useful for others. And, it is
easier for others to add information to an existing document, than to start
from scratch.
> Perhaps a format where each include file is commented on, and general
> things like the config file, etc... ?
All functions (even platform specific ones) should go into the function
reference, but it's a good idea to have a list of platform specific functions
in the platform.sgml files, too. The same is true for the platform specific
header file (there is only one top level header file - others should not be
used directly by an application).
As I've learned, it is not a good idea, to add the linker config to any
documentation, since the linker config changes too often. Having a copy in the
docs means that all docs for all platforms have to be changed when something
in the linker config changes. It is better to point to the config file, which
is part of the documentation. But the docs should explain the general setup of
the linker config for this platform.
I will try to come up with a template and then we'll see.
Regards
Uz
--
Ullrich von Bassewitz uz_at_musoftware.de
----------------------------------------------------------------------
To unsubscribe from the list send mail to majordomo_at_musoftware.de with
the string "unsubscribe cc65" in the body(!) of the mail.
This archive was generated by hypermail 2.1.3 : 2003-09-18 11:57:30 CEST