[linux-audio-user] some thoughts about Linux audio software documentation

Lee Revell rlrevell at joe-job.com
Thu Aug 12 19:31:10 EDT 2004


On Thu, 2004-08-12 at 19:18, jjbenham at chicagoguitar.com wrote:
> > -----Original Message-----
> > From: Dave Phillips [mailto:dlphilp at bright.net]
> > Sent: Thursday, August 12, 2004 01:13 PM
> > To: 'LAU Mail'
> 
> I always wanted to write documentation for audio projects. The problem is I cannot figure out how to do that. I don't know how to learn a certain aspect of a program without reading through the source code. jcsound is an example. It compiles smoothly. I run it with the orc and sco included. I have been reading through the source for days trying to figure out what is going wrong. I am learning more alot about c programming and the csound api in the process. For me at the moment jcsound will load csound as an alsa seq client. I write to the port using aplaymidi --port 128:0 and I connect the jack client to alsa_playblack blah blah. I just don't get any sound.
> 

Just document the parts of the program you find useful.  It isn't
necessary to understand every aspect of the program.  Other people will
fill in the rest.  The developers in many cases will be able to
contribute a lot more once you have documented the basic use of the
program.

Lee




More information about the Linux-audio-user mailing list