- updated README and opensync-plugin/README with more current
[barry.git] / opensync-plugin / README
blob8ab225e056fbc2eb7970d0b4a120c27d3eb4b8eb
2 *****************************************************************************
3 *  CAUTION: This is alpha software.  Please make complete backups of your   *
4 *           Blackberry device before experimenting.  While the author has   *
5 *           had good success with this software, that is no guarantee that  *
6 *           you will.  Please make backups.                                 *
7 *****************************************************************************
9 Introduction:
10 -------------
11 This directory contains a plugin for the OpenSync framework, which can
12 be used to synchronize between handhelds and desktop management software,
13 such as Evolution and Mozilla Sunbird.
15 Please note that this plugin has the potential to not only change the
16 data in your Blackberry handheld, but also, through sending sync ADD,
17 MODIFY and DELETE changes, can change the data in your address book
18 and calendar in your desktop software of choice.  As this plugin is
19 in development, please exercise caution, and make backups of your
20 Blackberry (see the ../gui directory) *and* backups of your desktop
21 software's data.
24 You can find more information on the OpenSync framework at the following
25 website:
27         http://www.opensync.org/
31 Library Dependencies:
32 ---------------------
34 You will need the following packages installed on your system, including
35 any dev or devel packages that come along with them.
37         pkg-config              Used by the configure scripts
38         libopensync-0.22        OpenSync framework library
39         sqlite                  Required by OpenSync
40         glib2                   Required by OpenSync
41         libxml2                 Required by OpenSync
42         libbarry 0.x            In the same tarball as this code.
43         libusb                  Required by libbarry
44         openssl                 Required by libbarry
46 In addition to libopensync, you will need a plugin for your desktop
47 software of choice, or for other handheld devices, such as the Palm.
48 Please see the OpenSync website for a list of available plugins.
50 If you've installed Barry or OpenSync in a non-standard spot, use something
51 like the following:
53         export PKG_CONFIG_PATH="/home/cdfrey/Barry/lib/pkgconfig:/home/cdfrey/software/lib/pkgconfig"
54         ./configure --prefix=/home/cdfrey/Barry
58 Installation:
59 -------------
61         cd opensync-plugin
62         ./configure
64                 (pkg-config will be used to find required libraries...
65                 make sure they are installed in standard locations,
66                 or that PKG_CONFIG_PATH is set appropriately)
68         make
69         su
70         make install
73 Please report any bugs you find to the Barry mailing list.
75 Thanks!
77 April 2007