Re: Pingus Readme

[David Philippi]

On Tue, Apr 06, 2004 at 11:02:30PM +0100, Neil Mitchell wrote:
> I have written (or gathered together) such a readme for the users, and would
> like feedback - is this a better direction than lots of small readmes? Is

It's a good idea to have a central readme for users, but yours seems to
include too much.

> HTML the right choice? Does the readme have the right content areas in? A

html is the right choice for a readme containing overall documentation.

> This takes all the content from:
> AUTHORS
> COPYING
> INSTALL.unix

Those three are meant to stay seperate. The first is best served standing
alone as a way to gather contact information, the license needs to be easily
found and installation instructions should also be easy to find and they
must be plain text. On a unix like system, you're most likely to view them
from a text console using a textviewer, not a textmode html reader.

> The files I have marked for inclusion in a developers readme are:
> INSTALL.unix
> INSTALL.Win32
> MAINTAINING
> README.Win32

I guess those could be put together into one readme for developers, I don't
think that joe average wants to read them anyway.
 
> If this is a sensible idea, then I'll draft a basic developers readme as
> well and flesh out (or ask for information for) some of the topics in the
> user readme.

Go on, ask your questions. Cleaning up the documentation is on my todo for
0.6.1 anyway, so your help is appreciated. :-)

Bye David