Re: [NonGNU ELPA] New packages: elquery, file-ring, metamorph

[Adam <adam.niederer@gmail.com>]

I've devised a way to create an info file from my README with a bit of 
clever formatting and pandoc, which should solve the issue of 
documentation not being shipped to the user.

Perhaps the build process could convert the README to an info file if no 
texi files exist in the repository?

-Adam

On 3/29/22 09:51, T.V Raman wrote:
> 
> The better solution would be for the package to come with a short info
> file -- see packages like  embark. Then the info file just shows up
> when you hit  info.
> Adam writes:
>   > 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.
>