On Mon, 15 Oct 2001, Jaroslav Kysela wrote:
> 
> >     I think in ORA's "In a Nutshell" series might be trademarked. How
> > about an ALSA Programmer's Guide that is similar to the OSS Programmer's
> > Guide? Check out the OSS Programmer's Guide at
> > http://www.opensound.com/pguide/
> 
> I'm going to prepare something, but it's very difficult to do everything.
> I would really appreciate, if someone goes through my notes, enhances them
> or ask for more ommited details in my text. It's call for all people. I
> just began, the texts are available from the mail ALSA page or they are
> in alsa-lib/doc directory (easy readable via ASCII tools, but the
> doxygen's output makes the reading much easier, including hypertext
> links).

        What are your plans for documentation? I propose we could keep
the doxygen stuff the way it is and it would be an API Reference Manual.
Then we could create a new document that would help application
programmers, this would be an ALSA Programmer's Guide.

        I've seen several requests from application developers on this
list for simple code examples to look at. I thought the ALSA Programmer's
Guide would step someone through the process of creating simple 
applications: WAV player, mixer, MIDI player, etc. If someone needed more
detail, they could dive into the API Reference manual.

        I'd be willing to take plain text submissions for a programmer's
guide, edit them (spelling, grammar, etc.), format them for DocBook, and
publish it all into PDF and HTML. I've converted the ALSA mini-HOWTO to
DocBook, so I have experience doing this.


-- kevin at kevindumpscore dot com



_______________________________________________
Alsa-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/alsa-devel

Reply via email to