[Lmuse-user] documentation

[Florian J. <flo...@we...>]

Hi

i've started yet another approach for documentation. under doc/, there's 
a documentation.tex. (obviously, a LaTeX document).

i would like to see you all to participate in writing this 
documentation. even if you don't know LaTeX at all, it is not hard. and 
even ugly documentation is better than none at all.

the file contains a huge top-comment. please read it. it contains rules 
to adhere to, and also a small cheatcheet for latex-newbies.


it's split in three parts: user's manual, internals and design decisions.
most guys from lmuse-user will probably only be able to contribute to 
the user's manual: please try to explain some things. basic concepts in 
MusE, how to do things (for the LaTeX-gurus, feel free to add 
screenshots), why to do things etc.

tim, robert, orcan, maybe one or also both geoffs (and of course anyone 
else who can help), please write any "internals" section you can write. 
i don't expect you to crawl to the code, reverse-engineer it and write 
documentation. but if you just reverse-engineered some code anyway, or 
when you just know how stuff works, please write it down ;)
i'm sure this will attract new developers, as they just can dive in and 
start contributing, instead of having to learn and reverse-engineer for 
half a year.

tim, robert, orcan, (and of course anyone else ;) ), when writing about 
some internals, please also update the design decisions chapter. this 
one is meant as a mid-time discussion platform (while the code is NOT!). 
i'd also prefer if we could move these huge discussions from several 
source files into this chapter, retaining only a short summary and a 
reference to the doc in the source.

in doc/old, there's some german old documentation. i'll see if it can be 
reused, and eventually translate it into german and into LaTeX. (if 
other germans are around (dennis?) and have too much time, feel free to 
do this as well ;) just inform me to avoid duplicate work)

i hope that we some day will have a comprehensive, complete 
documentation for both users and developers ;)

please participate.
greetings
flo