search

nicferrier / elmarmalade

emacs-lisp version of the marmalade package repository
111 stars 21 forks source link

404 on -readme.txt links #122

Open wasamasa opened 8 years ago

wasamasa commented 8 years ago

I'm currently playing around with package archives and found out package.el is capable of fetching a README corresponding to the commentary section of a package by looking up /packages/<package>-readme.txt. This works fine on GNU ELPA, MELPA and MELPA Stable, but fails on Marmalade with a 404 error.

All I can find in the sources about it is this cryptic comment. Surely this is an error, given how commentary sections are displayed in the package pages?

wasamasa commented 8 years ago

I've found out meanwhile that MELPA does extract the READMEs with lm-commentary from lisp-mount.el. This should be relatively simple to implement for single-file packages. I'm less sure how it would be done for multi-file packages. Currently a file matching ^README is used for these, perhaps figuring out how MELPA manages that would be useful.

edit: If my-package-pkg.el is given, MELPA will extract the commentary as described above from my-package.el. Marmalade could do better by using a README file if it exists, otherwise falling back to that.