diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2012-01-14 16:31:53 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-01-14 16:31:53 +0000 |
| commit | 8e1feacc0d6de27bf627a418f8cfc572c4562d40 (patch) | |
| tree | 2ee023a1be12fe5d757c1f34aa4601c6fb956a7e /README.md | |
| parent | 96ebafec4a5134f3a0efacb5db8f392a0799c886 (diff) | |
moved api docs, updated README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 4 insertions, 2 deletions
@@ -2,10 +2,11 @@ Alot is an experimantal 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 in `docs/user` for advanced usage and cusomization. +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][api]. Their sources live in `docs/api`. +current HEAD can be found [here][api]. Their sources live in `docs/dev`. Do comment on the code or file issues! I'm curious what you think of it. You can talk to me in #notmuch@Freenode. @@ -50,4 +51,5 @@ The key bindings for the current mode are listed upon pressing `?`. [notmuch]: http://notmuchmail.org/ [urwid]: http://excess.org/urwid/ [api]: http://alot.rtfd.org +[userdocs]: http://pazz.github.com/alot/ [wiki]: https://github.com/pazz/alot/wiki |