From ed1e78bcc0d7fb99f94d299964562d4460f0541c Mon Sep 17 00:00:00 2001 From: Patrick Totzke Date: Wed, 11 Jan 2012 15:04:40 +0000 Subject: updated README and removed CUSTOMIZE as sphinx generated user docs now live in /docs/user --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 065de0e9..27c9f75f 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3