Re: [boost] [git] Submodule's readme and logo

Subject: Re: [boost] [git] Submodule's readme and logo
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2013-12-13 07:28:01

> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Mateusz Loskot
> Sent: Friday, December 13, 2013 11:32 AM
> To: boost_at_[hidden]
> Subject: Re: [boost] [git] Submodule's readme and logo
> 
> On 13 December 2013 11:23, Adam Wulkiewicz <adam.wulkiewicz_at_[hidden]> wrote:
> >
> > In Boost.Geometry we recently added a readme file (currently only in
> > develop branch http://github.com/boostorg/geometry/tree/develop) and
> > some basic wiki.
> >
> > From one of the discussions (by Mateusz Loskot):
> >
> > What I'd suggest is to create README.{md|markdown} file in root
> > directory of geometry repo:
> > have big heading on top
> >
> > [LOGO] Boost.Geometry
> >
> > The readme could also explain briefly what's around, what is include
> > folder, what is example, test folder.
> > and link to the main documentation and wiki pages.
> >
> > GitHub has somewhat 'trained' people there always is a README file
> > (seehttp://tom.preston-werner.com/2010/08/23/readme-driven-development
> > .html) so many users expect to use it as a first contact with a
> > project.
> >
> >
> > I believe having those files in all submodules would have a positive
> > impact on the GitHub community and the users. Furthermore the style of
> > those files could be more or less unified. Therefore I've prepared
> > semi-consistent set of logos for some of the libraries: http://github.com/awulkiew/boost-logos.
> > I decided to achieve the consistency by using the Boost logo as a base.
> >
> > Let me know what do you think about it. And don't hesitate to write
> > about your ideas or propose changes.
> 
> FYI, I have asked about use of README some time ago, w/o replies yet
> http://lists.boost.org/Archives/boost/2013/12/209229.php

Should it contain little more than a link to www.boost.org?

Then we won't need to change much?

If we don't have the release number, someone won't have to remember to change it ;-)

Paul

PS I think the logos are a bit too fancy - I'm not sure that we really need a different one for each library?

---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
[phone]  07714330204
pbristow_at_[hidden]