couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Noah Slater <nsla...@apache.org>
Subject Re: [PROPOSAL] Pulling INSTALL.* into the docs
Date Wed, 22 May 2013 13:13:15 GMT
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

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message