Re: [ELPA] Submitting new package Org-remark

[Noboru Ota <me@nobiot.com>]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> Looks good, added,
> [ I used `README.org` for the readme, instead of :make "README-elpa", tho  ]

Thank you, Stefan.

Could we discuss the use of `README.org` and `README-elpa` a bit
further, please? Perhaps we need both :readme and :make specs.

I would like to use an ASCII export of README.org, not the raw
README.org file for the package description.

Currently, `describe-package' shows the raw `README.org` *after* the
package has been installed.  I have observed the following details
below, and thought I should generate `README-elpa` to have the same
`README` before and after installation of package. This way, I can also
have a link to an Info node directly within the description (I provide
an Info node as a user manual).


Observation below in Emacs 27.2 on Windows and Emacs 29.0.50 on Ubuntu
Linux:

1. Before the user installs a package, `describe-package` (and
   `package-list-packages`) displays `package-name-readme.txt`.  ELPA
   generates it and when `README.org` is used as the README file, it
   gets exported to ASCII plain text (I believe this is done in
   functions `elpaa--get-README' and `elpaa--section-to-plain-text' in
   elpa-admin.el)


2. After the user has installed a package, `describe-package` (and
   `package-list-packages`) displays one of these files: "README-elpa"
   "README-elpa.md" "README" "README.rst" "README.org".  When
   `README.org` is used, the raw text is displayed without being
   exported to ASCII format (I believe this is done in function
   `describe-package-1' and `package--get-description')


Warm regards,
Noboru