Mailing-List: contact cygwin-apps-help AT sourceware DOT cygnus DOT com; run by ezmlm
list-help: <mailto:cygwin-apps-help AT sourceware DOT cygnus DOT com>
list-post: <mailto:cygwin-apps AT sourceware DOT cygnus DOT com>
Sender: cygwin-apps-owner AT sourceware DOT cygnus DOT com
Delivered-To: mailing list cygwin-apps AT sourceware DOT cygnus DOT com
Sender: corinna AT snoopy DOT vinschen DOT de
Message-ID: <393D54D8.DCA7AFB2@vinschen.de>
Date: Tue, 06 Jun 2000 21:45:28 +0200
From: Corinna Vinschen <corinna AT vinschen DOT de>
Reply-To: cygapp <cygwin-apps AT sourceware DOT cygnus DOT com>
X-Mailer: Mozilla 4.73 [en] (X11; I; Linux 2.2.14 i686)
X-Accept-Language: de, en
MIME-Version: 1.0
To: cygapp <cygwin-apps AT sourceware DOT cygnus DOT com>
Subject: [RFD]: Where to put the important README files?
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

Hi all,

I want to ask you all for the following:

Some packages in the Cygwin distribution and some other ported
packages are not that easy to install and they don't run OOTB.
After unpacking, they need further configuration by the user.

An example is the inetutils package. The server tools can't work
without some special configuration.

To keep the user informed, those packages need mostly a special
README file, which should be part of the tar.gz file.

In the case of inetutils, it's an `inetutils.README' which
currently will be unpacked into the root directory :-(

Note, that those README files are special READMEs which are
valid for the ported package! They are completely different
from the man or info files which are often already part of the
unported package.

My suggestion is, to choose a directory that the user _knows_
as the directory containing all important README files of all
those packages. Furthermore it would be possible to implement
some sort of automatism which looks for a new version of a
README file after unpacking the tar file. This would enable
the option to show the README files from `setup.exe'.

The question is now: Where to put that directory in the Cygwin
directory tree?

Some suggestions:

	/usr/doc
	/README
	/etc/FAQ

Regards,
Corinna

-- 
Corinna Vinschen
Cygwin Developer
Cygnus Solutions, a Red Hat company