README

   1 OpenSync Framework
   2 ==================
   3
   4 OpenSync is a plugin-based application that basically provides a framework
   5 for syncing groups which can have two or more members.
   6
   7 This is the Akonadi (KDE 4.x) PIM synchronisation framework.
   8 It provides sync ability with KDE > 4.5 using the akonadi interface.
   9
  10 Important
  11 =========
  12
  13 This code was not tested well, so you've been warned!
  14
  15 Requirements
  16 ============
  17 - libopensync1 (v.0.40)
  18
  19
  20 Installation
  21 ============
  22 export PKG_CONFIG_PATH=/path/to/opensync/installation_prefix/lib/pkgconfig
  23
  24 mkdir build
  25 cd build
  26 cmake -DCMAKE_INSTALL_PREFIX=$installation_prefix /path/to/opensync/source/
  27 make
  28 make install
  29
  30 Usage
  31 ============
  32
  33 1. After installation configure the plugin with "--configure" option.
  34    (This is optional if you want to have all supported sync types)
  35 2. Discover supported features on both sides (sync members and akonadi)
  36    with "--discover" option. This step will discover sync features (supported
  37    formats) and akonadi collection. They will be available in the configuration
  38    file for further setup (but will be disabled by default).
  39 3. Reconfigure the plugin with "--configure" option. Most likely you will need
  40    to enable or disable sync with given collection represented as a ressource in
  41    the configuration file (step2 above).
  42 4. Sync with the "--sync" or similar option
  43
  44 Known Issues
  45 ============
  46
  47 If you modify an item try to sync and reject, then things got messed up.
  48 I'm still trying to understand why.
  49
  50 Links
  51 =====
  52
  53 [1] http://www.opensync.org/wiki/download
  54 [2] http://cryptomilch.de/~dgollub/talks/OpenSync_FOSDEM_2007.pdf