Re: README used by NonGNU packages "remotely" even though it's ignored

[Philip Kaludercic]

Daniel Semyonov <daniel@dsemy.com> writes:

> Hi,
>
> I noticed that the description shown on the NonGNU ELPA website for my
> packages (swsw and vcomplete), as well as the description shown through
> Emacs when viewing a version of the packages that isn't installed
> locally is the content of the README file included in their respective
> repositories.  However, both packages explicitly ignore that file (using
> an '.elpaignore' file).

Ignored files specify what files should not be added to the package
tarball.

> When viewing the description of a locally installed version of the
> packages, the commentary is shown (as is expected).
>
> I wonder if this behavior is intended, and if so whether it is
> documented anywhere?

See [0].  By default the README file is used.  If you prefer to, it is
possible to configure using the commentary section.

[0] 
https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/README?h=elpa-admin#n132,

> Regards,
> Daniel