incubator-lucy-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Peter Karman <>
Subject Re: [lucy-dev] README/CHANGES and host-specific distro archives
Date Mon, 11 Apr 2011 16:35:54 GMT
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.


Peter Karman  .  .

View raw message