README

   1 How To Build This Template
   2 -=-=-=-=-=-=-=-=-=-=-=-=-=
   3
   4 cd <project_name_path>
   5 mkdir build
   6 cd build
   7 cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR -DCMAKE_BUILD_TYPE=debugfull ..      <- do not forget the ..
   8 make
   9 make install or su -c 'make install'
  10
  11 where $KDEDIR needs to be set to your KDE installation prefix.
  12
  13 to uninstall the project:
  14 make uninstall or su -c 'make uninstall'
  15
  16 Note: you can use another build path. Then cd in your build dir and:
  17 export KDE_SRC=path_to_your_src
  18 cmake $KDE_SRC -DCMAKE_INSTALL_PREFIX=$KDEDIR -DCMAKE_BUILD_TYPE=debugfull
  19
  20
  21 Implementation hints
  22 -=-=-=-=-=-=-=-=-=-=
  23
  24 The code generated by this template can be compiled without any further
  25 changes, so you can start with your own code right away.
  26
  27 However, there are a couple of things you will need to change outside the
  28 resource's code, i.e. in the resource's .desktop file:
  29
  30 - Name field: the name of the resource with which it will be displayed in
  31   system settings and applications which can add resources on their own.
  32   E.g. MyBackend Resource
  33
  34 - Comment field: short description of the resource, also used to be
  35   displayed, e.g. For calendars and contacts stored in MyBackend
  36
  37 - Icon field: if you are not writing a contact (addressbook) resource, you have
  38   to change this to either an icon for the respective MIME type you are going
  39   to provide or use a resource specific icon which you provide yourself
  40
  41 - X-Akonadi-MimeTypes field: if you are not writing a contact (addressbook)
  42   resource, you have to change this to either a known MIME type or one you
  43   install together with the resource.
  44   If your resource can provide data of more than one MIME type, you can
  45   specific all possible ones as a comma separate list.
  46
  47   Common MIME types are:
  48   * text/directory: for contact data
  49   * text/calendar: for calendar data (there are Akonadi defined subtypes
  50     available, e.g. application/x-vnd.akonadi.calendar.event)
  51   * message/rfc822: for e-mails and usenet news
  52
  53 The template comes with an input file for KDE's KConfigXT framework
  54 for improved configuration file handling. The generated class is called
  55 "Settings", so access to its data is provided through its singleton
  56 instance method Settings::self().
  57 See http://techbase.kde.org/Development/Tutorials/Using_KConfig_XT
  58
  59 Documentation
  60 -=-=-=-=-=-=-
  61
  62 The Akonadi-KDE API documentation can be found here:
  63 http://api.kde.org/4.x-api/kdepimlibs-apidocs/akonadi/html/index.html
  64
  65 General developer information, e.g. tutorials can be found here:
  66 http://techbase.kde.org/Projects/PIM/Akonadi
  67
  68 Project homepage is http://www.akonadi-project.org/
  69
  70 IRC: #akonadi on freenode network
  71
  72 ----------------------------
  73 Please send all comments to:
  74 Kevin Krammer
  75 kevin@akonadi-project.org
  76
  77 Last update: May 2008