From d4c25dd636d1ff1e0c6fd92f4f65dd5684cf37df Mon Sep 17 00:00:00 2001 From: djcb Date: Fri, 6 Jan 2012 13:04:33 +0200 Subject: [PATCH] * README: add some mu introduction text --- README | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README b/README index e69de29b..e9aee1b8 100644 --- a/README +++ b/README @@ -0,0 +1,29 @@ +Welcome to mu! +-------------- + +Given 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 +mail - in particular, to instantly find that one important e-mail you need right +now. + +mu[1] is a tool for dealing with e-mail messages stored in the Maildir-format. mu's +main purpose is to help you to quickly find the messages you need; in addition, +it allows you to view messages, extract attachments, create new maildirs, … See +the mu cheatsheet[2] for some examples. + +Searching works by first indexing your messages into a Xapian-database, which +can then be queried using a custom query language. + +Built on top of mu there are some extensions: + + * mu-for-emacs (mu4e): a full-features e-mail client that runs inside emacs + * mu-guile: bindings for the Guile/Scheme programming language + +Mu is primarily written in C and a bit of C++, with parts of mu4e written in +Emacs-lisp and mu-guile in Scheme. + +Note, mu is available in Debian/Ubuntu under the name "maildir-utils" because +they don't like short names. + +[1] http://www.djcbsoftware.nl/code/mu/ +[2] http://www.djcbsoftware.nl/code/mu/cheatsheet.html