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. These members could
   6 be just about any kind of database we have a plugin like:
   7
   8  - A folder filled with vcard files containing contacts (file-sync)
   9  - An LDAP server having a huge list of contacts (ldap-sync)
  10  - An application like Mozilla Sunbird or Google Calendar managing calendars
  11  - A PIM (Personal Information Management) like Ximian Evolution or KDE PIM
  12  - A mobile phone with contacts/calendars/notes entries
  13
  14 OpenSync is not only limited to sync PIM data.
  15
  16 The technical aspects of how the synchronization is implemented can be found
  17 in this document [2] or in the OpenSync whitepaper stored in docs/ Each
  18 device has its own way of storing information and the purpose of OpenSync
  19 is to extract this information and provide inconvertibility using an
  20 XML intermediate. OpenSync without any plugins is incapable of doing any
  21 synchronization.
  22
  23 Requirements
  24 ============
  25 - CMake 2.4.4 or higher <http://www.cmake.org/>
  26 - libxslt <http://xmlsoft.org/XSLT/>
  27
  28
  29 Installation
  30 ============
  31
  32 To build OpenSync you need CMake, (check for unit tests - optional) and
  33 the devel packages of sqlite3, glib2, and libxml2. swig for python bindings
  34 (optional). We only support out of source builds, which means you have to
  35 create a separated build directory.
  36
  37 mkdir build
  38 cd build
  39 cmake -DCMAKE_INSTALL_PREFIX=$prefix /path/to/opensync/source/
  40 make
  41 make install
  42
  43 Links
  44 =====
  45
  46 [1] http://www.opensync.org/wiki/download
  47 [2] http://cryptomilch.de/~dgollub/talks/OpenSync_FOSDEM_2007.pdf
  48