diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2012-01-11 15:04:40 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-01-11 15:04:40 +0000 |
| commit | ed1e78bcc0d7fb99f94d299964562d4460f0541c (patch) | |
| tree | fdcf7f76e39cfaa0f583810452ce7d03ebd6eada /README.md | |
| parent | f4676a931614ed15dea3059a9a70d269f267813b (diff) | |
updated README and removed CUSTOMIZE
as sphinx generated user docs now live in /docs/user
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 6 insertions, 7 deletions
@@ -1,12 +1,11 @@ -Alot is a terminal interface for [notmuch mail][notmuch] written in -python using the [urwid][urwid] toolkit. +Alot is an experimantal terminal MUA based on [notmuch mail][notmuch]. +It is written in python using the [urwid][urwid] toolkit. -The files `INSTALL.md` and `CUSTOMIZE.md` contain instructions on how to set it -up and customize respectively. -Autogenerated API docs for the current release can be found [here][api]. -Their sources live in the `docs` directory. +See `INSTALL.md` for instructions on how to set it up and have a look +at the user manual in `docs/user` for advanced usage and cusomization. -The current top-notch version for the courageous lives in branch 'testing'. +Development happens in branch 'testing', autogenerated API docs for the +current HEAD can be found [here][api]. Their sources live in `docs/api`. Do comment on the code or file issues! I'm curious what you think of it. You can talk to me in #notmuch@Freenode. |