Hi All,

I've pushed an initial version of the Csound System Documentation to
the csound6 git repo.  It is located at
csound6/doc/csound_system_documentation.tex.  Some notes:

1. I originally started the document before I worked on my slides for
the "How Csound Works" talk from the CS Conference.  I filled in a few
sections before I moved to the slides.  Some of the proposed sections
did not make it to the slides, and some things in the slides should
probably go back into the document.

2. I originally wrote the doc using Markdown, but converted it to
LaTeX using pandoc.  The output lost some formatting and did some
sections differently than I would imagine we should use.  Take it as
just a starting point and please feel free to restructure.

3. The document should be considered as a reference for describing how
Csound works internally.  I think it would be appropriate to have the
document to target developers as an audience, and that we should
assume experience with C when writing.

4. The document might be useful for Csound API developers, but I think
the target should be developers who want to work on Csound itself.

5. I think an end goal would be that any part of the Csound system
should be documented here.  That'd include things like "How do xargs
work", "Opcode Argument Type specification", "Runtime Process Model",
"API", etc.

6. I think the document should describe architecture and mechanisms,
but should refer to files and functions when it goes really low-level.

Ultimately, the document is not really for those who know the system
but those who don't. I've got a particular view of the system from my
own history, so the above thoughts are just my own thoughts and what I
think developers new to Csound code might want.  I'd love to hear
perspectives on what others might like from the document.

Thanks!
steven

------------------------------------------------------------------------------
Android is increasing in popularity, but the open development platform that
developers love is also attractive to malware creators. Download this white
paper to learn more about secure code signing practices that can help keep
Android apps secure.
http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

I will take a look and contribute what I can. Thanks for doing this work.

And oh yes, thanks for doing this in LaTeX!

Best,

Mike

===========================

Michael Gogins
Irreducible Productions
http://michaelgogins.tumblr.com
Michael dot Gogins at gmail dot com

On Fri, Nov 1, 2013 at 12:48 PM, Steven Yi <stevenyi@gmail.com> wrote:

Hi All,

I've pushed an initial version of the Csound System Documentation to
the csound6 git repo.  It is located at
csound6/doc/csound_system_documentation.tex.  Some notes:

1. I originally started the document before I worked on my slides for
the "How Csound Works" talk from the CS Conference.  I filled in a few
sections before I moved to the slides.  Some of the proposed sections
did not make it to the slides, and some things in the slides should
probably go back into the document.

2. I originally wrote the doc using Markdown, but converted it to
LaTeX using pandoc.  The output lost some formatting and did some
sections differently than I would imagine we should use.  Take it as
just a starting point and please feel free to restructure.

3. The document should be considered as a reference for describing how
Csound works internally.  I think it would be appropriate to have the
document to target developers as an audience, and that we should
assume experience with C when writing.

4. The document might be useful for Csound API developers, but I think
the target should be developers who want to work on Csound itself.

5. I think an end goal would be that any part of the Csound system
should be documented here.  That'd include things like "How do xargs
work", "Opcode Argument Type specification", "Runtime Process Model",
"API", etc.

6. I think the document should describe architecture and mechanisms,
but should refer to files and functions when it goes really low-level.

Ultimately, the document is not really for those who know the system
but those who don't. I've got a particular view of the system from my
own history, so the above thoughts are just my own thoughts and what I
think developers new to Csound code might want.  I'd love to hear
perspectives on what others might like from the document.

Thanks!
steven

------------------------------------------------------------------------------
Android is increasing in popularity, but the open development platform that
developers love is also attractive to malware creators. Download this white
paper to learn more about secure code signing practices that can help keep
Android apps secure.
http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/csound-devel