documentation update

[pkg/abook.git] / README

diff --git a/README b/README
index b94900ca12d80ff7120f49017df119287e0494b7..9ef376f1f0b489f37840f827fb97a680b3b0cf25 100644 (file)
--- a/README
+++ b/README
@@ -7,13 +7,14 @@ Abook is an addressbook program with mutt mail client support.
 COMPILATION
 
 To compile abook you must have ncurses developement libraries installed.
-Starting from version 0.4.10 abook is know to compile with the native curses
-library of SUN Solaris and OpenBSD.
+Starting from version 0.4.10 abook is known to compile with the native curses
+library of SUN Solaris and OpenBSD. Since version 0.5.0 GNU readline is
+required.
 
-If you compile with --enable-debug flag you should run abook like this:
-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.)
+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
+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
@@ -42,6 +43,15 @@ 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 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
 
 If your language specific characters don't work correctly make sure
@@ -63,6 +73,5 @@ See COPYING for details.
 CONTACT AUTHOR
 
 Send bugreports, fixes, wishes etc. to Jaakko Heinonen
-<jheinonen@users.sourceforge.net> or preferably use the mailing list. (See
-http://abook.sourceforge.net/ for details)
+<jheinonen@users.sourceforge.net>