/kf6-qt6/pim/akonadi/templates/akonadiserializer/README

0001 How To Build This Template
0002 -=-=-=-=-=-=-=-=-=-=-=-=-=
0003
0004 --- On Linux & similar:
0005
0006 cd <project_name_path>
0007 mkdir build
0008 cd build
0009 cmake .. -DCMAKE_INSTALL_PREFIX=$MY_PREFIX -DCMAKE_BUILD_TYPE=Debug
0010 make
0011 make install or su -c 'make install'
0012
0013 (MY_PREFIX is where you install your Akonadi setup, replace it accordingly)
0014
0015 to uninstall the project:
0016 make uninstall or su -c 'make uninstall'
0017
0018 Note: you can use another build path. Then cd in your build dir and:
0019 export MY_SRC=path_to_your_src
0020 cmake $MY_SRC -DCMAKE_INSTALL_PREFIX=$MY_PREFIX -DCMAKE_BUILD_TYPE=Debug
0021
0022 --- On Windows:
0023
0024 cd <project_name_path>
0025 mkdir build
0026 cd build
0027 cmake .. -DCMAKE_INSTALL_PREFIX=%MY_PREFIX% -DCMAKE_BUILD_TYPE=Debug
0028 [n]make
0029 [n]make install
0030
0031 (MY_PREFIX is where you install your Akonadi setup, replace it accordingly)
0032
0033 to uninstall the project:
0034 [n]make uninstall
0035
0036 Note: use nmake if you're building with the Visual Studio compiler, or make
0037 if you're using the minGW compiler
0038
0039
0040 Implementation hints
0041 -=-=-=-=-=-=-=-=-=-=
0042
0043 The code generated by the template can be compiled without any further
0044 changes, so you can start with your own code right away.
0045
0046 However, there are a couple of things you will need to change outside the
0047 serialzer's code, i.e. in the serializer's .desktop file:
0048
0049 - Name field
0050
0051 - Comment field
0052
0053 - Type field: MIME type of your data type
0054
0055
0056 Documentation
0057 -=-=-=-=-=-=-
0058
0059 The Akonadi-KDE API documentation can be found here:
0060 https://api.kde.org/kdepim/akonadi/html/index.html
0061
0062 General developer information, e.g. tutorials can be found here:
0063 https://techbase.kde.org/KDE_PIM/Akonadi
0064
0065 The contact site can be found here:
0066 https://community.kde.org/KDE_PIM/Contact