From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Adam <adam.niederer@gmail.com>
Cc: "T.V Raman" <raman@google.com>, kfogel@red-bean.com, emacs-devel@gnu.org
Subject: Re: [NonGNU ELPA] New packages: elquery, file-ring, metamorph
Date: Thu, 31 Mar 2022 08:48:34 -0400 [thread overview]
Message-ID: <jwvfsmyz3ww.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <6490b69b-36b6-67e9-a124-b5086935dd04@gmail.com> (Adam's message of "Wed, 30 Mar 2022 21:55:22 -0400")
> I've devised a way to create an info file from my README with a bit of
> clever formatting and pandoc, which should solve the issue of documentation
> not being shipped to the user.
AFAIK the users *should* already be able to see the
README if they use a recent enough Emacs.
IOW if that doesn't work, please file a bug report.
> Perhaps the build process could convert the README to an info file if no
> texi files exist in the repository?
The README and the doc are meant to be two different things.
The README is supposed to be a short presentation of what the package does.
Of course, you can use a `README.org` and use that same file for `:readme`
and for `:doc` but that will lead to the same doc being duplicated.
Stefan
next prev parent reply other threads:[~2022-03-31 12:48 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-28 3:58 [NonGNU ELPA] New packages: elquery, file-ring, metamorph Adam
2022-03-28 6:59 ` Visuwesh
2022-03-28 17:21 ` T.V Raman
2022-03-29 1:53 ` T.V Raman
2022-03-29 3:43 ` Karl Fogel
2022-03-29 5:23 ` Adam
2022-03-29 13:51 ` T.V Raman
2022-03-31 1:55 ` Adam
2022-03-31 12:48 ` Stefan Monnier [this message]
2022-04-01 3:28 ` Adam
2022-04-01 13:11 ` Stefan Monnier
2022-04-03 10:25 ` Stephen Leake
2022-03-29 13:50 ` T.V Raman
2022-03-29 14:42 ` Stephen Leake
2022-03-29 8:28 ` Stefan Monnier
2022-03-28 22:09 ` Adam
2022-03-28 23:10 ` Ergus
2022-04-01 9:10 ` Augusto Stoffel
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=jwvfsmyz3ww.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=adam.niederer@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=kfogel@red-bean.com \
--cc=raman@google.com \
/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).