summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2017-06-01 10:05:28 +0100
committerPatrick Totzke <patricktotzke@gmail.com>2017-06-01 10:05:28 +0100
commit70cc98c4ca9df85411a810e0a23b0cdaeb716813 (patch)
treef2eea6861f5f995aeb89d994f7505b34e48d9df6 /README.md
parenta0b2ef99b7b3a32e58946bfc42bff6c4d9085fed (diff)
update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 21 insertions, 17 deletions
diff --git a/README.md b/README.md
index 2516aabc..3ff55159 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,37 @@
-Alot is an experimental terminal MUA based on [notmuch mail][notmuch].
-It is written in python using the [urwid][urwid] toolkit.
-
[![Build Status][travis-img]][travis]
[![Code Issues][quantcode-img]][quantcode]
-Have a look at the [user manual][docs] for installation notes, advanced usage,
-customization, hacking guides and [frequently asked questions][FAQ].
-Do comment on the code or file issues!
+Alot is a terminal-based mail user agent based on the [notmuch mail indexer][notmuch].
+It is written in python using the [urwid][urwid] toolkit and features a modular and command prompt driven interface to provide a full MUA experience as an alternative to the Emacs mode shipped with notmuch.
-Most of the developers hang out in `#alot@freenode`, feel free to ask questions or make suggestions there.
-Current features include:
--------------------------
- * modular and command prompt driven interface
+Notable Features
+----------------
* multiple accounts for sending mails via sendmail
- * spawn terminals for asynchronous editing of mails
+ * can spawn terminal windows for asynchronous editing of mails
* tab completion and usage help for all commands
* contacts completion using customizable lookups commands
* user configurable keyboard maps
- * theming, optionally in 2, 16 or 256 colours
- * tag specific theming and tag string translation
- * (python) hooks to react on events and do custom formatting
- * python shell for introspection
+ * customizable colour and layout themes
+ * python hooks to react on events and do custom formatting
* forward/reply/group-reply of emails
* printing/piping of mails and threads
- * notification popups with priorities
+ * configurable status bar with notification popups
* database manager that manages a write queue to the notmuch index
- * configurable status bar
* full support for PGP/MIME encryption and signing
+Installation and Customization
+------------------------------
+Have a look at the [user manual][docs] for installation notes, advanced usage,
+customization, hacking guides and [frequently asked questions][FAQ].
+We also collect user-contributed hooks and hacks in a [wiki][wiki].
+
+Most of the developers hang out in `#alot@freenode`, feel free to ask questions or make suggestions there.
+You are welcome to open issues or pull-requests on the github page.
+
+
Basic Usage
-----------
The arrow keys, `page-up/down`, `j`, `k` and `Space` can be used to move the focus.
@@ -45,9 +46,12 @@ are available. Usage information on any command can be listed by typing `help YO
to the prompt; The key bindings for the current mode are listed upon pressing `?`.
See the [manual][docs] for more usage info.
+
+
[notmuch]: http://notmuchmail.org/
[urwid]: http://excess.org/urwid/
[docs]: http://alot.rtfd.org
+[wiki]: https://github.com/pazz/alot/wiki
[FAQ]: http://alot.readthedocs.io/en/latest/faq.html
[features]: https://github.com/pazz/alot/issues?labels=feature
[travis]: https://travis-ci.org/pazz/alot