emacs
/
mu
mirror of https://github.com/djcb/mu.git
1
0
Fork 0
Code Issues Releases Wiki Activity

README: remove README.org 

We don't need both README(markdown) and README.org (org-mode).
This commit is contained in:
Dirk-Jan C. Binnema 2020-01-01 13:44:16 +02:00
parent 8aa433b56b
commit 0f98fbec2d
3 changed files with 21 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile.am
View File

@ -87,6 +87,7 @@ gitcheck:
EXTRA_DIST= \
TODO \
HACKING \
README \
gtest.mk \
NEWS \
NEWS.org \

60
README
View File

@ -1,45 +1,25 @@
README
======
Welcome to mu!
---------------
Welcome to mu & mu4e!
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] is a tool for dealing with e-mail messages stored in the
Maildir-format. =mu='s purpose in life is to help you to quickly find the
messages you need; in addition, it allows you to view messages, extract
attachments, create new maildirs, and so on. See the [mu cheatsheet] for some
examples. =mu= is fully documented.
After indexing your messages into a [Xapian]-database, you can search them using
a custom query language. You can use various message fields or words in the
body text to find the right messages.
Built on top of =mu= are some extensions (included in this package):
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, and quickly file away message for later use.
- mu-for-emacs ([mu4e]): a full-featured e-mail client that runs inside emacs
- [mu-guile]: bindings for the Guile/Scheme programming language (version 2.0
and later)
- a toy GTK+-interface called 'mug' (in the 'toys/' subdir)
`mu` is a tool for dealing with e-mail messages stored in the Maildir-format. `mu`'s purpose in life
is to help you to quickly find the messages you need; in addition, it allows you to view messages,
extract attachments, create new maildirs, and so on. See the [mu cheatsheet] for some examples. =mu=
is fully documented.
=mu= is written in C and a bit of C++ (to interface with Xapian), with =mu4e=
written in [Emacs-Lisp] and =mu-guile= in a mix of C and Scheme.
Note, =mu= is available in Debian/Ubuntu under the name =maildir-utils=;
apparently because they don't like short names. It's also possible to confuse
that name with the [GNU Mailutils] project (which is totally unrelated) - but
now you have been warned.
After indexing your messages into a [Xapian](http://www.xapian.org)-database, you can search them
using a custom query language. You can use various message fields or words in the body text to find
the right messages.
[mu]: http://www.djcbsoftware.nl/code/mu
[mu cheatsheet]: http://www.djcbsoftware.nl/code/mu/cheatsheet.html
[Xapian]: http://www.xapian.org
[mu4e]: http://www.djcbsoftware.nl/code/mu/mu4e.html
[mu-guile]: http://www.djcbsoftware.nl/code/mu/mu-guile.html
[Emacs-Lisp]: http://en.wikipedia.org/wiki/Emacs-Lisp
[GNU Mailutils]: http://mailutils.org/
Built on top of `mu` are some extensions (included in this package):
* mu4e: a full-featured e-mail client that runs inside emacs
* mu-guile: bindings for the Guile/Scheme programming language (version 2.2 and later)
`mu` is written in C and C++; `mu4e` is written in elisp, and `mu-guile` in a mix of C and Scheme.
Note, `mu` is available in Linux distributions (e.g. Debian/Ubuntu and Fedora) under the name
`maildir-utils`; apparently because they don't like short names.

33
README.org
View File

@ -1,33 +0,0 @@
* 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.
[[http://www.djcbsoftware.nl/code/mu][mu]] is a tool for dealing with e-mail messages stored in the
Maildir-format. =mu='s purpose in life is to help you to quickly find the
messages you need; in addition, it allows you to view messages, extract
attachments, create new maildirs, and so on. See the [[http://www.djcbsoftware.nl/code/mu/cheatsheet.html][mu cheatsheet]] for some
examples. =mu= is fully documented.
After indexing your messages into a [[http://www.xapian.org][Xapian]]-database, you can search them using
a custom query language. You can use various message fields or words in the
body text to find the right messages.
Built on top of =mu= are some extensions (included in this package):
- mu-for-emacs ([[http://www.djcbsoftware.nl/code/mu/mu4e.html][mu4e]]): a full-featured e-mail client that runs inside emacs
- [[http://www.djcbsoftware.nl/code/mu/mu-guile.html][mu-guile]]: bindings for the Guile/Scheme programming language (version 2.0
and later)
- a toy GTK+-interface called 'mug' (in the 'toys/' subdir)
=mu= is written in C and a bit of C++ (to interface with Xapian), with =mu4e=
written in [[http://en.wikipedia.org/wiki/Emacs-Lisp][Emacs-Lisp]] and =mu-guile= in a mix of C and Scheme.
Note, =mu= is available in Debian/Ubuntu under the name =maildir-utils=;
apparently because they don't like short names. It's also possible to confuse
that name with the [[http://mailutils.org/][GNU Mailutils]] project (which is totally unrelated) - but
now you have been warned.
You can install `mu` package in the openSUSE Linux distro with `zypper in maildir-utils`