From: Florian J. <flo...@we...> - 2012-05-26 23:37:57
|
push even though the file is filling, there's little user manual in it yet :/ i'd like to ask every user of muse to explain things a little. for example, someone needs to explain stuff about audio INs and AUXs, on how to use the wave editor etc etc. please help with writing ;) if you decide to help, a small notice via mail would be nice, so others (which currently means: i) know which parts NOT to write because some other guy is already writing this. again: please please help, we need you ;) if you have any LaTeX newbie questions, i'd be glad to help you (as in "point you to the right sources", not as in "do a full-time tutor job" ;) ) as long it gets you towards writing documentation ;) greetings flo Am 22.05.2012 01:04, schrieb Florian Jung: > 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 > > ------------------------------------------------------------------------------ > Live Security Virtual Conference > Exclusive live event will cover all the ways today's security and > threat landscape has changed and how IT managers can respond. Discussions > will include endpoint security, mobile security and the latest in malware > threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ > _______________________________________________ > Lmuse-user mailing list > Lmu...@li... > https://lists.sourceforge.net/lists/listinfo/lmuse-user > |