Re: [elpa] main 2ec80977e1: * elpa-packages (dired-preview): New package

[Protesilaos Stavrou]

> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Date: Sat,  8 Jul 2023 17:47:44 -0400

Hello Stefan,

>> --- a/elpa-packages
>> +++ b/elpa-packages
>> @@ -211,6 +211,10 @@
>>    :ignored-files ("LICENSE"))
>>   (dired-du          :url nil)
>>   (dired-git-info    :url "https://github.com/clemera/dired-git-info";)
>> + (dired-preview             :url 
>> "https://git.sr.ht/~protesilaos/dired-preview";
>> +  :doc "README.org"
>> +  :readme "README.md"
>> +  :ignored-files ("COPYING" "doclicense.texi"))
>>   (disk-usage                :url 
>> "https://gitlab.com/ambrevar/emacs-disk-usage";)
>>   (dismal            :url nil)
>>   (djvu                      :url nil)
>
> Isn't it odd to name your manual `README.org`?
> IOW to use the same name as for the "read me" file.
>
> I mean you avoid a name collision only by accident because the two
> happen to use different source formats and hence different extensions.

I had thought about calling it <package-name>.org, like I do with the
modus-themes, but that does not immediately call attention the way
"README" does.

The README.md is there (i) for Git forges that do not parse Org files
properly and (ii) to provide basic information about the package.

All the best,
Protesilaos (or simply "Prot")

-- 
Protesilaos Stavrou
https://protesilaos.com