From: Gavin Sinclair <gsinclair@...>
Date: 2004-02-14T07:10:54+09:00
Subject: Re: Standard libraries

On Saturday, February 14, 2004, 5:04:45 AM, Dave wrote:


> On Feb 13, 2004, at 11:52, J.Herre wrote:

>> What I'm doing with an extension I'm trying to write today is to use
>> rdoc to weave a README.en from the makefile so that someone who just
>> downloads it will have something to read immediately.
>>

> What I've done is create a README in RDoc format, and then use 
> :include: to include it in the documentation for the main class. That
> way I don't add too much to the class itself, and people can find the
> README when they look for it.

I generally include the README in the documentation as itself, rather
than including it.  I also make it the 'main' page so it's the first
thing people see.

Gavin