Mailing-List: contact lucy-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: lucy-dev@incubator.apache.org
Received-SPF: pass (nike.apache.org: local policy)
Message-ID: <4DA32DEA.5080907@peknet.com>
Date: Mon, 11 Apr 2011 11:35:54 -0500
From: Peter Karman <peter@peknet.com>
Reply-To: peter@peknet.com
User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US;
 rv:1.9.2.15) Gecko/20110303 Thunderbird/3.1.9
MIME-Version: 1.0
To: lucy-dev@incubator.apache.org
References: <20110331004934.GA29728@rectangular.com>
In-Reply-To: <20110331004934.GA29728@rectangular.com>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Subject: Re: [lucy-dev] README/CHANGES and host-specific distro archives

Marvin Humphrey wrote on 3/30/11 7:49 PM:

> In the repository right now, we only have one README file, trunk/perl/README.
> It contains traditional Perl module installation instructions, in addition to
> a minimal description of the library.  I propose that we make the following
> adaptations:
> 
>     * Move the perl module installation instructions into a new file,
>       trunk/perl/INSTALL.
>     * Add a new file trunk/INSTALL which instructs the user to chdir into
>       the directory of their host language of choice and follow the
>       instructions in the INSTALL document there.  This file would be omitted
>       from the CPAN/PyPI/etc. archives.
>     * Eliminate trunk/perl/README.  
>     * Add trunk/README, which would contain a minimal description of the
>       library, the incubation disclaimer, and a pointer to INSTALL.  This file
>       would be copied (along with LICENSE and NOTICE) to the host language dir
>       when preparing the host-specific distro archive.
> 

+1 to all of the above


> We also have to consider how to handle change info.  Right now there is only
> one CHANGES file: trunk/perl/Changes.  It contains almost nothing, since
> we're starting fresh.  I propose we eliminate that file and create
> trunk/CHANGES, which would record change info for all of Lucy, including all
> bindings.  It would be copied along with README, LICENSE and NOTICE when
> building a host-specific distro.


+1

-- 
Peter Karman  .  http://peknet.com/  .  peter@peknet.com