Updated ChangeLog and whitespace
[barry.git] / opensync-plugin / README
bloba24b43e207a0c0049116685fdf6e920674be3537
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 Development note: this plugin is in flux, not only from pure development,
10         but also because the OpenSync libraries themselves are getting
11         close to releasing version 0.30, which changes some internals
12         from 0.22.  This plugin is currently based on 0.22, but that may
13         change in the future.
15 Introduction:
16 -------------
17 This directory contains a plugin for the OpenSync framework, which can
18 be used to synchronize between handhelds and desktop management software,
19 such as Evolution and Mozilla Sunbird.
21 Please note that this plugin has the potential to not only change the
22 data in your Blackberry handheld, but also, through sending sync ADD,
23 MODIFY and DELETE changes, can change the data in your address book
24 and calendar in your desktop software of choice.  As this plugin is
25 in development, please exercise caution, and make backups of your
26 Blackberry (see the ../gui directory) *and* backups of your desktop
27 software's data.
30 You can find more information on the OpenSync framework, as well
31 as tarballs for the version 0.22 library and plugins, at the following
32 website:
34         http://www.opensync.org/
38 Library Dependencies:
39 ---------------------
41 You will need the following packages installed on your system, including
42 any dev or devel packages that come along with them.
44         pkg-config              Used by the configure scripts
45         libopensync-0.22        OpenSync framework library
46         sqlite                  Required by OpenSync
47         glib2                   Required by OpenSync
48         libxml2                 Required by OpenSync
49         libbarry 0.x            In the same tarball as this code.
50         libusb                  Required by libbarry
52 In addition to libopensync, you will need a plugin for your desktop
53 software of choice, or for other handheld devices, such as the Palm.
54 Please see the OpenSync website for a list of available plugins.
56 If you've installed Barry or OpenSync in a non-standard spot, use something
57 like the following:
59         export PKG_CONFIG_PATH="/home/cdfrey/Barry/lib/pkgconfig:/home/cdfrey/software/lib/pkgconfig"
60         ./configure --prefix=/home/cdfrey/Barry
64 Installation:
65 -------------
67         cd opensync-plugin
68         ./configure
70                 (pkg-config will be used to find required libraries...
71                 make sure they are installed in standard locations,
72                 or that PKG_CONFIG_PATH is set appropriately)
74         make
75         su
76         make install
79 Please report any bugs you find to the Barry mailing list.
81 Thanks!
83 August 2007