|
From: | Adam |
Subject: | Re: [NonGNU ELPA] New packages: elquery, file-ring, metamorph |
Date: | Tue, 29 Mar 2022 01:23:14 -0400 |
User-agent: | Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.7.0 |
On 3/28/22 23:43, Karl Fogel wrote:
On 28 Mar 2022, T.V Raman wrote:Sadly putting the examples in README is not very helpful since installing your package from melpa doesn't appear to bring down the README; one shouldn't need to click through to Github to find out how to use it if one has installed the package.Hunh. Would that be something we should make a general fix for? E.g., when a package 'foo' gets installed from melpa or from some similar package repository, and it has a README, then the README gets installed alongside the package as 'foo-README', or something like that?
I think that's a good way of going about it. From a cursory glance it looks like the most popular out-of-tree libraries (s, f, a, ht, epl, async, ov, popup, uuidgen) have most of their usage examples and documentation in the README.
Even if NonGNU's supposed to be a bit more curated, having everybody synchronize their README with docstrings or texi manuals might be a bit wasteful. I don't know if there's a way to do that automatically.
[Prev in Thread] | Current Thread | [Next in Thread] |