Re: README's for extension building
| From: | Matt McClanahan | Date: | Mon, 06 Nov 2000 22:40:15 +0000 |
| Subject: | Re: README's for extension building | ||
| References: | 1 | Groups: | php.dev |
| Request: | Send a blank email to php-dev+get-37319@lists.php.net to get a copy of this message | ||
On Tue, 7 Nov 2000, Zeev Suraski wrote:
> I think it'd be a good idea to start adding README's the the various
> ext/modules, that give people the minimal necessary information about these
> extensions. In two lines, what this extension is for, and if it requires a
> 3rd party library, where can one get it (in case it's not commercial).
>
> Comments?
Sounds like a good idea. I might also suggest that it be brought in line
with the manual sections for each extension. Most of the extensions added
to the manual recently (Curl, PayFlow, output control, etc) have included
some information about what the extension does, and links to exterior
libraries where relevant. It'd make sense to me if the short README text
in the source tree was also the first part of each manual section. Then
the manual could follow it up with more extensive information if need be.
Matt