From 7c00cf10fb0e3017dd77faa80523f7983b288e41 Mon Sep 17 00:00:00 2001 From: cdfrey Date: Sun, 29 Apr 2007 20:53:02 +0000 Subject: [PATCH] - updated README and opensync-plugin/README with more current build instructions --- ChangeLog | 3 ++ README | 6 +-- opensync-plugin/README | 129 ++++++++++++++++++++++++++++++------------------- 3 files changed, 83 insertions(+), 55 deletions(-) rewrite opensync-plugin/README (98%) diff --git a/ChangeLog b/ChangeLog index ea59a25f..e9471479 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ Release: version 0.7 - 2007/04/?? ------------------------------------------------------------------------------ +2007/04/29 + - updated README and opensync-plugin/README with more current + build instructions 2007/04/27 - opensync module: - removed some unneeded trace logs diff --git a/README b/README index f5936750..98d31d9d 100644 --- a/README +++ b/README @@ -117,12 +117,10 @@ To generate the Doxygen documentation: To build the OpenSync module: ----------------------------- + (see opensync-plugin/README for more information) + cd opensync-plugin ./configure - - set --with-libusb - set --with-barry - make su make install diff --git a/opensync-plugin/README b/opensync-plugin/README dissimilarity index 98% index ea60f38b..8ab225e0 100644 --- a/opensync-plugin/README +++ b/opensync-plugin/README @@ -1,51 +1,78 @@ -Hi, - -so you are interested in writing a plugin for the -OpenSync synchronization framework... Great! :) - -Here is what you have to do: - -Edit the files - -AUTHORS -INSTALL -LICENSE - -and fill in the required information. Then edit: - -configure.in - -and add any checks etc that you need for you plugin -to function. - -Then go to src/ and edit: - -Makefile.am - -there to suit your needs. Afterwards take a look at the example -source files of the plugin - -plugin.c -plugin.h - -and start writing the functions you need to connect, read and write -etc to your device. - -Then edit the default config file which must be the same name -as your plugin: - -plugin - -if you need to write a format plugin take a look at - -format.c - -Before running ./configure the first time you need to run -./autogen.sh once. - -If you need help, feel free to ask on the opensync mailing lists: -http://sourceforge.net/projects/opensync and go to "Lists" - -or ask on our irc channel: -server: irc.freenode.org -channel: #opensync + +***************************************************************************** +* CAUTION: This is alpha software. Please make complete backups of your * +* Blackberry device before experimenting. While the author has * +* had good success with this software, that is no guarantee that * +* you will. Please make backups. * +***************************************************************************** + +Introduction: +------------- +This directory contains a plugin for the OpenSync framework, which can +be used to synchronize between handhelds and desktop management software, +such as Evolution and Mozilla Sunbird. + +Please note that this plugin has the potential to not only change the +data in your Blackberry handheld, but also, through sending sync ADD, +MODIFY and DELETE changes, can change the data in your address book +and calendar in your desktop software of choice. As this plugin is +in development, please exercise caution, and make backups of your +Blackberry (see the ../gui directory) *and* backups of your desktop +software's data. + + +You can find more information on the OpenSync framework at the following +website: + + http://www.opensync.org/ + + + +Library Dependencies: +--------------------- + +You will need the following packages installed on your system, including +any dev or devel packages that come along with them. + + pkg-config Used by the configure scripts + libopensync-0.22 OpenSync framework library + sqlite Required by OpenSync + glib2 Required by OpenSync + libxml2 Required by OpenSync + libbarry 0.x In the same tarball as this code. + libusb Required by libbarry + openssl Required by libbarry + +In addition to libopensync, you will need a plugin for your desktop +software of choice, or for other handheld devices, such as the Palm. +Please see the OpenSync website for a list of available plugins. + +If you've installed Barry or OpenSync in a non-standard spot, use something +like the following: + + export PKG_CONFIG_PATH="/home/cdfrey/Barry/lib/pkgconfig:/home/cdfrey/software/lib/pkgconfig" + ./configure --prefix=/home/cdfrey/Barry + + + +Installation: +------------- + + cd opensync-plugin + ./configure + + (pkg-config will be used to find required libraries... + make sure they are installed in standard locations, + or that PKG_CONFIG_PATH is set appropriately) + + make + su + make install + + +Please report any bugs you find to the Barry mailing list. + +Thanks! + +April 2007 + -- 2.11.4.GIT