How To Build This Template
-=-=-=-=-=-=-=-=-=-=-=-=-=

--- On Unix:

cd <project_name_path>
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=$KDEDIRS -DCMAKE_BUILD_TYPE=Debug ..      <- do not forget the ..
make
make install or su -c 'make install'

where $KDEDIRS points to your KDE installation prefix.

to uninstall the project:
make uninstall or su -c 'make uninstall'

Note: you can use another build path. Then cd in your build dir and:
export KDE_SRC=path_to_your_src
cmake $KDE_SRC -DCMAKE_INSTALL_PREFIX=$KDEDIRS -DCMAKE_BUILD_TYPE=Debug

--- On Windows:

cd <project_name_path>
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug ..      <- do not forget the ..
[n]make
[n]make install

where %KDEDIRS% points to your KDE installation prefix.

to uninstall the project:
[n]make uninstall

Note: use nmake if you're building with the Visual Studio compiler, or make
if you're using the minGW compiler


Implementation hints
-=-=-=-=-=-=-=-=-=-=

The code generated by this template can be compiled without any further
changes, so you can start with your own code right away.

However, there are a couple of things you will need to change outside the
serialzer's code, i.e. in the serializer's .desktop file:

- Name field

- Comment field

- Type field: MIME type of your data type

Documentation
-=-=-=-=-=-=-

The Akonadi-KDE API documentation can be found here:
http://api.kde.org/4.x-api/kdepimlibs-apidocs/akonadi/html/index.html

General developer information, e.g. tutorials can be found here:
http://techbase.kde.org/Projects/PIM/Akonadi

Project homepage is http://www.akonadi-project.org/

IRC: #akonadi on freenode network

----------------------------
Please send all comments to:
Kevin Krammer
kevin@akonadi-project.org

Last update: July 2009
