discussion and development of piem
 help / color / mirror / code / Atom feed
* [PATCH 0/2] README updates
@ 2021-12-12 22:21 Kyle Meyer
  2021-12-12 22:21 ` [PATCH 1/2] README: Mention b4 and lei Kyle Meyer
  2021-12-12 22:21 ` [PATCH 2/2] README: Point to related projects Kyle Meyer
  0 siblings, 2 replies; 3+ messages in thread
From: Kyle Meyer @ 2021-12-12 22:21 UTC (permalink / raw)
  To: piem

Sean Whitton suggested that piem's README should point to mailscripts
(and vice versa) [*].  I haven't given much attention to the README,
hoping it has just enough to make people go to the documentation
(where mailscripts and other related projects are mentioned).
However, it does seem like a good idea for the README to link
mailscripts (and git-email) to increase the chances of helping someone
discover a tool that might be useful to them.

And while there, refresh the description of piem's functionality a
bit.

  [1/2] README: Mention b4 and lei
  [2/2] README: Point to related projects

 README | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)

[*]: https://inbox.kyleam.com/piem/YbZOh0yEFLBwVUMp@melete.silentflame.com/

base-commit: e519aa44d148d5b8f22d7fe8844dc566046b04c2
-- 
2.34.0


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH 1/2] README: Mention b4 and lei
  2021-12-12 22:21 [PATCH 0/2] README updates Kyle Meyer
@ 2021-12-12 22:21 ` Kyle Meyer
  2021-12-12 22:21 ` [PATCH 2/2] README: Point to related projects Kyle Meyer
  1 sibling, 0 replies; 3+ messages in thread
From: Kyle Meyer @ 2021-12-12 22:21 UTC (permalink / raw)
  To: piem

piem leans on b4 heavily, so it deserves a pointer in the README.
Plus, the next patch will mention b4 when it describes mailscripts,
and it seems a bit odd for that to be the only mention.

And lei wasn't a thing when this README was written, but it's
certainly worth highlighting now.
---
 README | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/README b/README
index a79f8eda..9c0bea47 100644
--- a/README
+++ b/README
@@ -5,9 +5,15 @@ piem --- Emacs tools and glue for working with public-inbox archives
 This project is currently in the early stages of development.  In
 general, anything that relates to interacting with public-inbox
 (https://public-inbox.org/README) archives from Emacs is worth
-considering, at least at this point.  Much of the current
-functionality focuses on mapping public-inbox endpoints (email, nntp,
-http, rss) to associated code repositories in order to apply patches.
+considering, at least at this point.
+
+Much of the current functionality focuses on mapping public-inbox
+endpoints (email, nntp, http, rss) to associated code repositories in
+order to apply patches, including integration with b4-am to extract
+and process patches (https://git.kernel.org/pub/scm/utils/b4/b4.git).
+Upcoming development will largely focus on extending the very basic
+support public-inbox's local email interface (lei).
+
 Documentation is available online at
 
     https://docs.kyleam.com/piem/
-- 
2.34.0


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH 2/2] README: Point to related projects
  2021-12-12 22:21 [PATCH 0/2] README updates Kyle Meyer
  2021-12-12 22:21 ` [PATCH 1/2] README: Mention b4 and lei Kyle Meyer
@ 2021-12-12 22:21 ` Kyle Meyer
  1 sibling, 0 replies; 3+ messages in thread
From: Kyle Meyer @ 2021-12-12 22:21 UTC (permalink / raw)
  To: piem; +Cc: Sean Whitton

Documentation/piem.texi has a section that lists related projects, but
highlight a couple in the README for visibility.

Cc: Sean Whitton <spwhitton@spwhitton.name>
Link: https://inbox.kyleam.com/piem/YbZOh0yEFLBwVUMp@melete.silentflame.com/
---
 README | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README b/README
index 9c0bea47..4dd52f98 100644
--- a/README
+++ b/README
@@ -27,3 +27,18 @@ Messages that include this address are public and available as
 public-inbox archives at
 
     https://inbox.kyleam.com/piem/
+
+
+Related projects
+----------------
+
+If you're interested in applying patches but aren't working with a
+public-inbox instance, it's still possible to use piem (see the
+documentation).  However, in this case, you may want to consider
+mailscripts (https://git.spwhitton.name/mailscripts/), a "collection
+of scripts for manipulating e-mail on Debian".  Its
+notmuch-extract-patch script (accessible via Emacs commands) provides
+an alternative to b4 for extracting a patch series from a thread.
+
+And if you're searching for an Emacs interface for *sending* patches,
+take a look at git-email (https://sr.ht/~yoctocell/git-email/).
-- 
2.34.0


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-12-12 22:21 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-12 22:21 [PATCH 0/2] README updates Kyle Meyer
2021-12-12 22:21 ` [PATCH 1/2] README: Mention b4 and lei Kyle Meyer
2021-12-12 22:21 ` [PATCH 2/2] README: Point to related projects Kyle Meyer

Code repositories for project(s) associated with this inbox:

	https://git.kyleam.com/piem/

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).