I am working on revising some of the basic documentation files that are in
CVS in the hope that we can have more complete information about Csound's
sources (i.e. contributors and included libraries) in each distribution.

I've added the names of numerous contributors that were missing to the
AUTHORS file.  I have a number of other changes in mind but thought I ought
to ask before treading on anyone else's toes.  My questions (as usual) are
multi-pronged:

- Are the files "readme-csound5.txt" and "readme-csound5-complete.txt" in
general use or are they only included by Michael in the Windows installers?
If not in general use, can we agree on some generic

- These readme files include a short list of contributors which partially
duplicates AUTHORS.  Would it make more sense to remove these lists and add
a note pointing to the file AUTHORS?

- Is it OK to convert these readme files to 8-bit Unicode (with BOM) from
the Windows Latin text encoding that they currently use?

- Would it be OK to expand the introductory, installation, and help
sections?  Among other things, I am thinking of adding comparable
information for the other Csound front ends included in our distributions as
exists for CsoundAC and CsoundVST.

- I've assembled a 300+ line summary of copyright notices and license info
for Csound and its dependencies that I think we should include with our
distributions.  Should I put that in the ReadMes or another file?

Thanks,

Anthony


------------------------------------------------------------------------------
Crystal Reports - New Free Runtime and 30 Day Trial
Check out the new simplified licensign option that enables unlimited
royalty-free distribution of the report engine for externally facing 
server and web deployment.
http://p.sf.net/sfu/businessobjects
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

I'm glad you're taking this on.

However, in general, it is always asking for trouble with computers
and computer data of any kind to have the same information in more the
one place. That is because, as you have just noticed and pointed out,
the information is inevitably better maintained in one place than in
the others, and so the total body of information soon becomes
incomplete or even contradicts itself.

Therefore, the best move is always to keep only one copy of the
information in one place. And that place should be the place that is
the most used. Not the most visible - the most used. With Csound, that
is the reference manual.

So, the information should be outright deleted from everywhere it
occurs except in the manual (or a header file, or a license file, or
whichever is actually most used), and all other locations, including
the most visible location, including the readme file, should simply
point to that one central file.

If it is felt to be essential to have a separate list of authors,
etc., then the manual should that information deleted from it, and the
list should either be pointed or, or #included.

Hope this helps,
Mike

On 4/25/09, Anthony Kozar  wrote:
> I am working on revising some of the basic documentation files that are in
> CVS in the hope that we can have more complete information about Csound's
> sources (i.e. contributors and included libraries) in each distribution.
>
> I've added the names of numerous contributors that were missing to the
> AUTHORS file.  I have a number of other changes in mind but thought I ought
> to ask before treading on anyone else's toes.  My questions (as usual) are
> multi-pronged:
>
> - Are the files "readme-csound5.txt" and "readme-csound5-complete.txt" in
> general use or are they only included by Michael in the Windows installers?
> If not in general use, can we agree on some generic
>
> - These readme files include a short list of contributors which partially
> duplicates AUTHORS.  Would it make more sense to remove these lists and add
> a note pointing to the file AUTHORS?
>
> - Is it OK to convert these readme files to 8-bit Unicode (with BOM) from
> the Windows Latin text encoding that they currently use?
>
> - Would it be OK to expand the introductory, installation, and help
> sections?  Among other things, I am thinking of adding comparable
> information for the other Csound front ends included in our distributions as
> exists for CsoundAC and CsoundVST.
>
> - I've assembled a 300+ line summary of copyright notices and license info
> for Csound and its dependencies that I think we should include with our
> distributions.  Should I put that in the ReadMes or another file?
>
> Thanks,
>
> Anthony
>
>
> ------------------------------------------------------------------------------
> Crystal Reports - New Free Runtime and 30 Day Trial
> Check out the new simplified licensign option that enables unlimited
> royalty-free distribution of the report engine for externally facing
> server and web deployment.
> http://p.sf.net/sfu/businessobjects
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>


-- 
Michael Gogins
Irreducible Productions
http://www.michael-gogins.com
Michael dot Gogins at gmail dot com

------------------------------------------------------------------------------
Crystal Reports - New Free Runtime and 30 Day Trial
Check out the new simplified licensign option that enables unlimited
royalty-free distribution of the report engine for externally facing 
server and web deployment.
http://p.sf.net/sfu/businessobjects
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net