Re: Documentation

[Hugo van der Merwe <hugo@mailroom.com>]

On Tue, 22 Aug 2000, Josip Rodin wrote:

<SNIP some "don't include" tips>

Thanks. Makes a lot of sense.

> > INSTALL
> 
> If it's generic, don't include it. If it explains only stuff about compiling
> from source, don't include it either.

Thanks. It's out.

> > NEWS
> 
> If it's like other NEWS files I've seen, this is fine. If there's no
> upstream changelog, use this as it.

This is a changelog, but there is also a "ChangeLog" file, probably
automatically generated because it doesn't have very much info in it. In
fact, it doesn't have version numbers in it either. I suppose I should I
throw out the ChangeLog file and rather use NEWS...? (Or try asking the
upstream author to merge the two?)

> > README
> 
> Usually fine... depends on the contents sometimes.
>
> > TODO
> 
> Ditto.

I think the TODO may be useful, for users to see what isn't there yet, or
what can be expected in the future.

> > as well as a debian/TODO file.
> 
> Is this getting installed in the binary package?

Yes, dh_installdocs does this. I think I'll probably take it out though, I
should rather just do the stuff than create a list... ;)

Thanks,
Hugo van der Merwe