From: Sidney Cadot (sidney_at_janis.pds.twi.tudelft.nl)
Date: 2000-03-17 01:05:52
The documentation for the cc65 toolsuite is now contained in a few ASCII
readme files in the doc directory. I would like to propose and volunteer
to convert these into a format that is more pleasing to the eye, using
LaTeX and ps2pdf (everybody can read PDF nowadays, I hope). I have quite
some experience with this, so a first draft shouldn't take more than a day
or so to do.
A good manual should contain the following, I think:
* Introduction
* Installation Guide for different environments:
DOS, Linux, Win32, ... ?
* small tutorial
* documentation for cl65 (compiler driver)
* documentation for ar65 (archive tool)
* documentation for ca65 (macro assembler)
* documentation for cc65 (compiler)
* documentation for ld65 (linker)
* C library docs
* platform-specific issues
* debugging
* compiler suite internals
* bugs and limitations
* FAQ
* acknowledgements
I could set up a CVS repository if anybody wants to volunteer to do
certain parts. Most importantly, the platform-specific part would need to
be done by people having access and experience with using cc65 on the
platform in question. I can do the Atari bit.
All this should only be done, IMHO, if Ullrich thinks this is a good idea.
Furthermore, he should have the final word as to the content of the
manual.
Any comments, especially about content (did I miss anything?) are
welcome. Also, suggestions for alternate formats (TexInfo? DocBook?) are
welcome too. As everyone knows, writing documentation is not the coolest
part about a software engineering undertaking. Still, it's very important,
so if anybody feels like volunteering (platform specifics, in-depth
subjects, native english speakers for proofreading...), please say so.
Best regards,
Sidney
+--------------------------------------------------------------------------+
| -- Sidney Cadot - sidney_at_ch.twi.tudelft.nl - ITS/TU Delft - tst. 3850 -- |
+--------------------------------------------------------------------------+
|/* C-code to calculate day-of-week (1901-2099). Type name for man page. */|
|main(int c,char**v){exit(printf("%sday.\n","Use MM/DD/YYYY argument to c" |
|"alculate week\0Mon\0/0/Tues\0/0Wednes\0Thurs\0/Fri\0/0/Satur\0/Sun"+(*++ |
|v?42+((5*atoi(6+*v)+"@GSTDLXDP_at_HT@"[atoi(*v)])/4+atoi(3+*v))%7*7:0))/30);}|
+--------------------------------------------------------------------------+
----------------------------------------------------------------------
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 : 2001-12-14 22:05:35 CET