- attempt to save database more safely

[pkg/abook.git] / README

diff --git a/README b/README
index 6589816039ada77e28987e2700454407517ca560..83bc73d2dfe000ed308824f1ced2282694923b91 100644 (file)
--- a/README
+++ b/README
@@ -9,25 +9,25 @@ COMPILATION
 To compile abook you must have ncurses developement libraries installed.
 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.
+required. Please note that other readline implementations don't work.
 
 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)
+NetBSD
+GNU/Hurd
 AIX 3.2.5
 HPUX
 Irix 6.5
 DEC alpha ?
-GNU/Hurd
 
 INSTALLATION
 
@@ -43,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
@@ -64,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.