From da515685f6ce43a08861fb3461ccc9a42b62197f Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Sat, 18 Apr 2026 12:10:16 +0300 Subject: README.org: improve --- README.org | 36 ++++++++++++++++++++---------------- assets/email-hazard.jpg | Bin 0 -> 19806 bytes 2 files changed, 20 insertions(+), 16 deletions(-) create mode 100644 assets/email-hazard.jpg diff --git a/README.org b/README.org index 9cba3d0..79ff99f 100644 --- a/README.org +++ b/README.org @@ -13,7 +13,9 @@ Welcome to ~mu~! -Latest development news: [[NEWS.org]]. +#+begin_html +drowning in email +#+end_html With the enormous amounts of e-mail many people gather and the importance of e-mail message in our work-flows, it's essential to quickly deal with all that @@ -21,23 +23,23 @@ mail - in particular, to instantly find that one important e-mail you need right now, and quickly file away message for later use. ~mu~ is a set of command-line tools for dealing with e-mail messages stored in the -Maildir-format. ~mu~'s goal is to help you to quickly find the messages you need, +[[https://en.wikipedia.org/wiki/Maildir][Maildir]]-format. ~mu~'s goal is to help you to quickly find the messages you need, view them, extract attachments, and so on. -#+BEGIN_HTML - -#+END_HTML +On top of ~mu~, some related tools are built: -After indexing your messages into a [[http://www.xapian.org][Xapian]]-database, you can search them through -a query language. You can use various message fields or words in the body text -to find the right messages. +- ~mu4e~: a full-featured e-mail client that runs inside [[https://www.gnu.org/software/emacs/][GNU/Emacs]] (more below) -Built on top of ~mu~ are some other tools (included in this package): +- ~mu-scm~: bindings for the [[https://www.gnu.org/software/guile/guile.html][Guile/Scheme]] programming language (version 3.0 and + later) -- ~mu4e~: a full-featured e-mail client that runs inside emacs (more below) +#+begin_html +mu structure diagram +#+end_html -- ~mu-scm~: bindings for the Guile/Scheme programming language (version 3.0 and - later) +After indexing your messages into a [[http://www.xapian.org][Xapian]]-database, you can search them through +a query language. You can use various message fields or words in the body text +to find the right messages. ~mu~ is written in C++; ~mu4e~ is written in ~elisp~ and ~mu-scm~ is written in a mix of C++ and Scheme. @@ -55,8 +57,8 @@ Users and developers are encouraged to join the [[https://groups.google.com/g/mu *mu* attempts to balance development speed and stability. -Active development takes place on ~master~ (the 1.14 series), and we maintain -~release/1.12~ as well, for any critical fixes. +Active development takes place on ~master~ (the 1.14 series), and we maintain the +~release/1.12~ branch as well, for any critical fixes. Every few months, we release a stable version (e.g. ~1.14.0~); development then continues in ~master~, with ~-pre~ (e.g. ~1.14.1-pre1~): ~-pre~-suffixed versions @@ -160,8 +162,10 @@ Mu4e is an e-mail client for [[https://www.gnu.org/software/emacs/][GNU/Emacs]] Since there are so many different ways people use e-mail, there are a lot of ways to customize it to your needs; see the [[https://www.djcbsoftware.nl/code/mu/mu4e/][Mu4e Reference Manual]] for all the details, here we include quick-start instructions, in the form of ~use-package~ -declaration. Much of it is commented-out, pick the parts that best fit your -particular needs; see the manual for a deeper dive. +declaration. + +Much of it is commented-out, pick the parts that best fit your particular needs; +see the manual for a deeper dive. #+begin_src elisp (use-package mu4e diff --git a/assets/email-hazard.jpg b/assets/email-hazard.jpg new file mode 100644 index 0000000..14d0302 Binary files /dev/null and b/assets/email-hazard.jpg differ -- cgit v1.0