diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2012-02-16 09:51:42 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-02-16 09:54:31 +0000 |
| commit | 7f12a1dc1f716a12266c3dd70f7c15521ee01a30 (patch) | |
| tree | d6c9f39b1fe33139e0d1488248d60c08dbe3838d /README.md | |
| parent | a984fe7a89adb092cbd0dd718b6737d37dc02df2 (diff) | |
updated README and INSTALL
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 8 insertions, 11 deletions
@@ -1,26 +1,22 @@ -Alot is an experimantal terminal MUA based on [notmuch mail][notmuch]. +Alot is an experimental terminal MUA based on [notmuch mail][notmuch]. It is written in python using the [urwid][urwid] toolkit. See `INSTALL.md` for instructions on how to set it up and have a look -at the [user manual][userdocs] (sources in in `docs/user`) -for advanced usage and customization. - -Development happens in branch 'testing', autogenerated API docs for the -current HEAD can be found [here][apidocs]. Their sources live in `docs/dev`. +at the [user manual][docs] for advanced usage, customization and hacking guides. Do comment on the code or file issues! I'm curious what you think of it. -You can talk to me in #notmuch@Freenode. +You can talk to me in `#notmuch@Freenode`. Current features include: ------------------------- * modular and command prompt driven interface * tab completion and usage help for all commands - * contacts completion using customizable `abook` lookups + * contacts completion using customizable lookups commands * user configurable keyboard maps * spawn terminals for asynchronous editing of mails * theming, optionally in 2, 16 or 256 colours * tag specific theming and tag string translation - * (python) hooks to react on events and do custom formating + * (python) hooks to react on events and do custom formatting * python shell for introspection * forward/reply/group-reply of emails * printing/piping of mails and threads @@ -30,6 +26,7 @@ Current features include: Soonish to be addressed non-features: ------------------------------------- +See [here][features], most notably: * encryption/decryption for messages (see branch `gnupg`) * live search results (branch `live`) * search for message (branch `messagesmode`) @@ -50,6 +47,6 @@ The key bindings for the current mode are listed upon pressing `?`. [notmuch]: http://notmuchmail.org/ [urwid]: http://excess.org/urwid/ -[userdocs]: http://alot.rtfd.org -[apidocs]: http://pazz.github.com/alot/ +[docs]: http://alot.rtfd.org +[features]: https://github.com/pazz/alot/issues?labels=feature [wiki]: https://github.com/pazz/alot/wiki |