From: Dmitry Gutov <dgutov@yandex.ru>
To: Stefan Monnier <monnier@IRO.UMontreal.CA>
Cc: emacs-devel@gnu.org
Subject: Re: Git version of ELPA
Date: Sat, 17 Aug 2013 02:04:00 +0300 [thread overview]
Message-ID: <520EAFE0.8020408@yandex.ru> (raw)
In-Reply-To: <520BEC92.401@yandex.ru>
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.html
link 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.html
avoids 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.
next prev parent reply other threads:[~2013-08-16 23:04 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-08-01 17:54 Git version of ELPA Stefan Monnier
2013-08-02 10:30 ` Andreas Schwab
2013-08-02 17:22 ` Stefan Monnier
2013-08-02 21:32 ` Andreas Schwab
2013-08-03 4:28 ` Stefan Monnier
2013-08-03 8:19 ` Eli Zaretskii
2013-08-11 22:08 ` Dmitry Gutov
2013-08-12 1:10 ` Stefan Monnier
2013-08-12 2:04 ` Stefan Monnier
2013-08-12 6:17 ` Dmitry Gutov
2013-08-12 15:24 ` Stefan Monnier
2013-08-12 16:23 ` Dmitry Gutov
2013-08-13 1:42 ` Stefan Monnier
2013-08-14 9:17 ` Dmitry Gutov
2013-08-14 15:30 ` Stefan Monnier
2013-08-14 16:48 ` Dmitry Gutov
2013-08-14 19:02 ` Stefan Monnier
2013-08-14 20:46 ` Dmitry Gutov
2013-08-16 23:04 ` Dmitry Gutov [this message]
2013-08-15 4:08 ` Stephen J. Turnbull
2013-08-15 18:38 ` Achim Gratz
2013-08-17 0:59 ` Dmitry Gutov
2013-08-13 5:16 ` Achim Gratz
2013-08-14 9:46 ` Dmitry Gutov
2013-08-14 18:13 ` Achim Gratz
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=520EAFE0.8020408@yandex.ru \
--to=dgutov@yandex.ru \
--cc=emacs-devel@gnu.org \
--cc=monnier@IRO.UMontreal.CA \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).