diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2011-10-24 10:42:37 +0100 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2011-10-24 10:42:37 +0100 |
| commit | b66ccfd799f60c14d94eba8a1b9ca4c20e52674a (patch) | |
| tree | b013ff59062d51c30d7d3b6ca6090afed9c3523f /README.md | |
| parent | 19bd46e24aeebbed3089ae891c082f99c2ed6bfd (diff) | |
updated docs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 23 insertions, 12 deletions
@@ -1,30 +1,31 @@ -This is a proposal for a terminal gui for [notmuch mail][notmuch] -written in python using the [urwid][urwid] toolkit. +This is a proposal for a terminal gui for [notmuch mail][notmuch] written in +python using the [urwid][urwid] toolkit. -You can find some old screenshots in `data/alot*png`, -the files `INSTALL` and `USAGE` contain instructions on how to set it up, -use and customize. These files are nicely rendered in the [github wiki][wiki]. -The API docs for the current master branch are [here][api]. -the `docs` directory contains their sources. +The files `INSTALL.md` and `CUSTOMIZE.md` contain instructions on how to set it +up and customize respectively. + +(slightly outdated) autogenerated API docs for the current master branch can be +found [here][api]. Their sources live in the `docs` directory. Do comment on the code or file issues! I'm curious what you think of it. 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 + * completion using addressbook lookups + * user configurable keyboard maps * spawn terminals for asynchronous editing of mails - * theming, optionally in monochromatic, 16 or 256 colours + * theming, optionally in 2, 16 or 256 colours * tag specific theming and tagstring translation * a hook system to inject one's own python code * python shell for introspection * forward/reply/group-reply of emails + * printing/piping of mails and threads * multiple accounts for sending mails via sendmail - * tab completion for commands and querystrings * priorizable notification popups * database manager that manages a write queue to the notmuch index - * user configurable keyboard maps - * printing/piping of mails and threads - * addressbook integration (dev branch) Soonish to be addressed non-features: ------------------------------------- @@ -33,6 +34,16 @@ Soonish to be addressed non-features: * folding for message parts * undo for commands + +Usage +===== +In all views, arrows, page-up/down, j,k and space can be used to move the focus. +Escape cancels prompts and Enter selects. Hit ":" at any time and type in commands +to the prompt. +Usage information on any command can be listed using `help YOURCOMMAND`. +The keybindings for the current mode are listet upon pressing '?'. + + [notmuch]: http://notmuchmail.org/ [urwid]: http://excess.org/urwid/ [api]: http://pazz.github.com/alot/ |