Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
MIME-Version: 1.0
In-Reply-To: 
 <CAKmKYaB9RgScpQgeGZEz+uFvrD1XXO3AZgA60fRptt5S7BC=bg@mail.gmail.com>
References: 
 <CAKmKYaBX-dK6DBMMKm0tLvBwpbsmQ_g_oDy_aFTWh7WTemSU3A@mail.gmail.com>
	<CAHdjipJc0x-dRNm9o325Eu-0C78btO=V+KRHFZp3GFN5r4bK1A@mail.gmail.com>
	<CAKmKYaADKVGmsi0xWkJ1pFYRG33aPDRCgWcXZU1+5puN1g4tqw@mail.gmail.com>
	<CAPaJBx6BHADBySu5aeYbg6ioiGKhBZ2LvtUiuF_=0wGBy7YS2A@mail.gmail.com>
	<CAKmKYaB9RgScpQgeGZEz+uFvrD1XXO3AZgA60fRptt5S7BC=bg@mail.gmail.com>
Date: Wed, 22 May 2013 14:13:15 +0100
Message-ID: 
 <CAPaJBx4+SjTH02zUBa3_5-OHvjQ7jxKLs=VWg9kJE8J2vGhsoA@mail.gmail.com>
Subject: Re: [PROPOSAL] Pulling INSTALL.* into the docs
From: Noah Slater <nslater@apache.org>
To: "dev@couchdb.apache.org" <dev@couchdb.apache.org>
Content-Type: multipart/alternative; boundary=90e6ba212477295e8e04dd4e5414

--90e6ba212477295e8e04dd4e5414
Content-Type: text/plain; charset=ISO-8859-1

On 22 May 2013 12:58, Dirkjan Ochtman <dirkjan@ochtman.nl> wrote:

> On Wed, May 22, 2013 at 1:51 PM, Noah Slater <nslater@apache.org> wrote:
> > Let's aim to get down to a single README.md file that:
>
> Maybe README.rst, since we're already using that for docs?


Good call.

(BTW, I say "aim" because LICENSE and NOTICE still need to exist, at an
absolute minimum.)

> a) looks good on GitHub, and
> > 2) gives a GitHub style overview, and
>
> I'm not sure what Github-style overviews look like, have (an) example(s)?
>

Ah, well what I meant is "GitHub-style". I know that's nebulous, so I guess
what I *really* mean is that GitHub-native projects write their READMEs
with the express understanding that it's the first thing many people read
about the project. i.e. Mini dev-oriented home-pages. So I think we should
aim to do something like that.


-- 
NS

--90e6ba212477295e8e04dd4e5414--