|
From: | Dmitry Gutov |
Subject: | Re: Git version of ELPA |
Date: | Sat, 17 Aug 2013 02:04:00 +0300 |
User-agent: | Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130803 Thunderbird/17.0.8 |
On 14.08.2013 23:46, Dmitry Gutov wrote:
Speaking of README file formats, maybe your current solution is good enough. The Melpa guys have intentionally settled on the same approach (use the Commentary from <package-name>.el): https://github.com/milkypostman/melpa/issues/522 https://github.com/milkypostman/melpa/pull/366 The idea is that README.md/org/etc in the root of the directory serves as an introduction, and it usually contains a section "how to install". The package description buffer, on the other hand, would be most useful if it has a short description of what the package is about and how to use it *once it's installed*.
Cases in point: http://elpa.gnu.org/packages/ggtags.html http://elpa.gnu.org/packages/ack.html http://elpa.gnu.org/packages/js2-mode.htmllink to http://elpa.gnu.org/ and mention M-x list-packages, both of which are somewhat extraneous.
http://elpa.gnu.org/packages/coffee-mode.html recommends cloning from GitHub and installing manually. http://elpa.gnu.org/packages/company.htmlavoids this problem largely accidentally, by having a homepage separate from the GitHub repo (which is relatively unusual).
Insidentally, this change (de728884) also broke the link from js2-mode's README.md to http://elpa.gnu.org/packages/js2-mode.html, because the surrounding text depends on the latter page having the description from Commentary. But no matter, that happens.
[Prev in Thread] | Current Thread | [Next in Thread] |