[jazzplusplus-devel] Doccumentation -- a scratchpad of thoughts

[D.B. M. <db...@ho...>]

Greetings,


As Pete said - "I was hoping this stuff would end up in jazz.tex"

On the night, I had thought "this stuff should go in jazz.tex"


I read through jazz.tex ..all of it. It's worth doing, it remarks
a far gone time...(even if that was less than 20 years ago).

Shiny pearls like this ;

For MIDI-only operation a 486 CPU (or equivalent) is sufficient in most                     
cases.  For satisfactory audio operation a Pentium CPU with 32 MBytes                       
RAM is recommended.


Call it sentimentality on my part if you like, but I figure a copy
of the original jazz.tex file should always remain, in tact, for historical
purposes...


Anyhow, reworking jazz.tex is almost tantamount to a rewrite. I've got no
problem with that, and for sure some passages of the old text
may find their way into the new draft....but....are we happy with
the formal and layout of the old jazz.tex documentation?


A lot of the htdocs are near a point where they'll be 'frozen' for
a time - they probably won't change until the code reaches a 
point closer to an  'official' release.


The reason I concluded to just continue adding to the
web/htdocs/documentation path, was to merely make these
additions 'visible', rather than obscured in jazz.tex right now,
....because we havn't discussed a plan here, or how things will be
done....etc etc etc..

What Pete said is right -- all this stuff *should* be in jazz.tex,
the htdocs should be generated from that (to ensure that
consistency between online and in-tree documentation)....


Comments please, how are we going to approach this?


Regards,

Donald B 
_________________________________________________________________
Never miss another e-mail with Hotmail on your mobile.
http://www.livelife.ninemsn.com.au/article.aspx?id=343869