|
|
Boost Interest : |
Subject: Re: [Boost-cmake] README.txt and Welcome.txt?
From: Beman Dawes (bdawes_at_[hidden])
Date: 2008-11-02 09:01:04
On Sun, Nov 2, 2008 at 8:48 AM, Doug Gregor <doug.gregor_at_[hidden]> wrote:
> On Sun, Nov 2, 2008 at 7:27 AM, Beman Dawes <bdawes_at_[hidden]> wrote:
> > As part of the merge to trunk, two files got added to boost-root:
> README.txt
> > and Welcome.txt.
> >
> > Was that intentional?
>
> Yes.
>
> > If so, what are these files, why are they needed, and how are they to be
> > maintained?
>
> They're used to build the graphical installers. Welcome.txt is the
> text you see when you initially open the installer, and README.txt
> comes up as the "release notes" a little later into the installer.
>
> README.txt will need to be updated with the summary of what's changed
> in each release (the same thing the release manager does for the
> release notes on SourceForge). Welcome.txt won't change.
Unless README.txt can be updated automatically, it is going to be a
maintenance problem for release managers.
Instead of having specific text that has to be changed each release, could
it contain the URL of the release notes on the web site?
If having these files in the root is bothersome, we can move them into
> tools/build/CMake; I'd suggest doing that for Welcome.txt but not for
> README.txt.
I'm primarily worried how to keep them up to date, although it does seem
that since stuff in tools/build/CMake depends on them, that
tools/build/CMake is a more natural location.
Also, does the installation build allow them to have comments? Particularly
if they are not in tools/build/CMake, it might be nice if they had comments
saying what they are and how they get maintained.
--Beman