[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Scheme-reports] distributed repository: README.txt doc as package requirement
- To: John Gabriele <jmg3000@x>
- Subject: Re: [Scheme-reports] distributed repository: README.txt doc as package requirement
- From: Alex Shinn <alexshinn@x>
- Date: Tue, 27 Sep 2011 12:33:11 +0900
- Cc: scheme-reports@x
- In-reply-to: <CAO9PwMWJ4e7cFoBP1sJ1CDGOT=AYK=kK7CedukmsGjZHbUnajA@mail.gmail.com>
- References: <CAO9PwMWJ4e7cFoBP1sJ1CDGOT=AYK=kK7CedukmsGjZHbUnajA@mail.gmail.com>
On Mon, Sep 26, 2011 at 1:19 PM, John Gabriele <jmg3000@x> wrote:
> I'd like to suggest that, as part of whatever package format is chosen
> (I'll assume "Snow/snowball/snowfort" for the following discussion),
> that the presence of a README file (written in some format easily
> convertible to html ([Pandoc's enhanced Markdown] would be my
> suggestion)) be a requirement.
As pointed out, we don't want to enforce a documentation
format. On the other hand, a common format does make
it easier to keep the style consistent and display the docs
directly on the site.
As a compromise, the tools can directly support certain
common formats (markdown, html, scribble) and for other
formats the publisher can just generate html before uploading.
Note third parties can supply their own documentation for
libraries, including translated versions of the original.
> (BTW, after writing this message, I'm liking the name "Snow" more and
> more. For example, it would be fun to read about "heavy snowfall this
> month!" (large number of snowballs added/updated),
In fact, we're about to enter an ice age :)
> Would uploading a snowball with the same name
> as an existing one lead to a snowball fight? :) )
Maybe we can use "snowball fight" instead of golfing?
And snow angels for test suites?
Scheme-reports mailing list