added keybinding for custom tab and added missing assert.h

[pkg/abook.git] / README

diff --git a/README b/README
index e4ce59c9af7e7a13f69ff3be4f884b1466aceaba..e1a604f67ce163ef5647dc16970b4d6d3e60fbde 100644 (file)
--- a/README
+++ b/README
@@ -12,22 +12,22 @@ library of SUN Solaris and OpenBSD. Since version 0.5.0 GNU readline is
 required.
 
 If you compile with --enable-debug flag you should redirect standard error
-to somewhere. (for example abook 2> debug or abook 2> /dev/null. Abook has
+to somewhere. (for example abook 2> debug or abook 2> /dev/null) Abook has
 been compiled and tested successfully on following platforms:
 (NOTE: All versions of abook haven't been tested on all platforms.)
 
-Linux (Debian GNU/Linux 2.1/2.2, RedHat 6.x)
-Solaris 2.4
-Solaris 2.5
-Solaris 2.6
-FreeBSD 3.3 (newer versions should be OK)
+Linux (Debian GNU/Linux, RedHat Linux, all other distributions with GNU ncurses
+       and GNU readline should work)
+Darwin
+Solaris
+FreeBSD
 OpenBSD
 NetBSD (reportedly requires ncurses to work properly)
+GNU/Hurd
 AIX 3.2.5
 HPUX
 Irix 6.5
 DEC alpha ?
-GNU/Hurd
 
 INSTALLATION
 
@@ -43,10 +43,14 @@ After this you can make queries from mutt using the query command ('Q')
 and add sender e-mail addresses to the addressbook from pager using 'A'
 command. (Of course you can choose another keybinding if you like.)
 
+It's also recommeded to set pipe_decode variable in mutt configuration.
+See the mutt manual for details.
+
 UPGRADING FROM VERSION 0.4
 
-You must import your abook 0.4 addressbook file because 0.5 uses different
-location to store the file.
+You must import your abook 0.4 addressbook file because it is stored
+to a different location. Configuration file is now located to $HOME/.abook/
+directory and it's called abookrc . (without leading dot)
 
 NOTES
 
@@ -69,5 +73,5 @@ See COPYING for details.
 CONTACT AUTHOR
 
 Send bugreports, fixes, wishes etc. to Jaakko Heinonen
-<jheinonen@users.sourceforge.net>
+<jheinonen@users.sourceforge.net> or use the mailing list.