Re: [LAD] Linux Audio Documentaion Effort : (Was "Question 0")

Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]
To: Harry van Haaren <harryhaaren@...>
Cc: <linux-audio-dev@...>
Date: Monday, November 28, 2011 - 9:49 pm

--20cf307ca3b4f89ac404b2d279ee
Content-Type: text/plain; charset=ISO-8859-1

2011/11/28 Harry van Haaren

> On Mon, Nov 28, 2011 at 4:55 PM, thijs van severen <

i'm basically saying that any form of documenting is good :)
IMHO starting high-level and working your way down is best. maybe make an
overview of the most important functions with explanation and (well
commented) code examples
it doesnt have to be in detail in the beginning, but it should grow as we
go along and above all it needs to be kept alive.
the only thing that is worse than having no documentation is having
outdated/inaccurate documentation

> I dont have coding skills, but if you need someone to help with the

--

follow me on my Audio & Linux blog !

--20cf307ca3b4f89ac404b2d279ee
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

2011/11/28 Harry van Haaren <harryhaaren@gmail.com>

On Mon, Nov 28, 2011 at 4:55 P=
M, thijs van severen <thijsvanseveren@gmail.com> wro=
te:

Documenting (code) is always a good idea.=A0
Its hard enoug to find and motivate people that have good coding skills, so=
the last thing you need is for those people to get frustrated while trying=
to find out where/how they should start.
Transparent, error-free documentation, website and active mailing list a=
re key here!I don't fully grasp your point =
here, are you saying we should create a resource like mentioned above or th=
at it should be based more about the "code" and working examples.=
..?

=A0i'm basically saying th=
at any form of documenting is good=A0 :)IMHO starting high-level and wo=
rking your way down is best.=A0 maybe make an overview of the most importan=
t functions with explanation and (well commented) code examples

it doesnt have to be in detail in the beginning, but it should grow as we g=
o along and above all it needs to be kept alive.the only thing that is =
worse than having no documentation is having outdated/inaccurate documentat=
ion

=A0

I dont have coding skills, but if you need someone to help with the docu=
mentation as such, i'm willing to help.Than=
ks, will keep that in mind! I'm currently drafting some Introductory &a=
mp; basic stuff like choosing a language & toolkits. Then I'll post=
that its open to all and write up some basic audio tutorials (adapted from=
my blog) JACK clients, MIDI in JACK, processing, ringbuffers, etc

All the best, -Harry
-- follow me on m=
y=A0Audi=
o & Linux blog
!

--20cf307ca3b4f89ac404b2d279ee--

Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]

Messages in current thread:
Re: [LAD] Linux Audio Documentaion Effort : (Was "Question 0"), thijs van severen, (Mon Nov 28, 4:55 pm)
Re: [LAD] Linux Audio Documentaion Effort : (Was "Question 0"), thijs van severen, (Mon Nov 28, 9:49 pm)
Re: [LAD] Linux Audio Documentaion Effort : (Was "Question 0"), Philipp Überbacher, (Wed Nov 30, 12:43 pm)
Re: [LAD] Linux Audio Documentaion Effort : (Was "Question 0"), Harry van Haaren, (Wed Nov 30, 12:51 pm)
Re: [LAD] Linux Audio Documentaion Effort : (Was "Question 0"), thijs van severen, (Tue Nov 29, 8:59 pm)
Re: [LAD] Linux Audio Documentaion Effort : (Was "Question 0"), Harry van Haaren, (Wed Nov 30, 12:19 pm)