apps/dolphin/src/README

   1 -----------------------------------------------
   2 Kde application framework template quickstart
   3 Author: Thomas Nagy
   4 Date: 2004-03-22
   5 -----------------------------------------------
   6
   7 This README file explains you basic things for starting with
   8 this application template.
   9
  10
  11 ** Building and installing **
  12
  13 * Build the configure script by "make -f Makefile.cvs"
  14
  15 * To clean, use "make clean", and to clean everything
  16 (remove the makefiles, etc), use "make distclean"
  17
  18 * To distribute your program, try "make dist".
  19 This will make a compact tarball archive of your release with the
  20 necessary scripts inside.
  21
  22 * Modifying the auto-tools scripts
  23 for automake scripts there is an excellent tutorial there :
  24 http://developer.kde.org/documentation/other/makefile_am_howto.html
  25
  26 * Simplify your life : install the project in your home directory for
  27 testing purposes.
  28 ./configure --prefix=/home/user/dummyfolder/
  29 In the end when you finished the development you can
  30 rm -rf /home/user/dummyfolder/
  31 without fear.
  32
  33
  34 ** Technologies **
  35
  36 * Build the menus of your application easily
  37 kde applications now use an xml file (*ui.rc file) to build the menus.
  38 This allow a great customization of the application. However, when
  39 programming the menu is shown only after a "make install"
  40
  41 For more details, consult :
  42 http://devel-home.kde.org/~larrosa/tutorial/p9.html
  43 http://developer.kde.org/documentation/tutorials/xmlui/preface.html
  44
  45 * Use KConfig XT to create your configuration dialogs and make
  46 them more maintainable.
  47
  48 For more details, consult :
  49 http://developer.kde.org/documentation/tutorials/kconfigxt/kconfigxt.html
  50
  51 * With KParts, you can embed other kde components in your program, or make your program
  52 embeddable in other apps. For example, the kmplayer kpart can be called to play videos
  53 in your app.
  54
  55 For more details, consult :
  56 http://www-106.ibm.com/developerworks/library/l-kparts/
  57 http://developer.kde.org/documentation/tutorials/dot/writing-plugins.html
  58 http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html
  59
  60 * With dcop, you can control your app from other applications
  61 Make sure to include K_DCOP and a kdcop: section in your .h file
  62 http://developer.kde.org/documentation/tutorials/dot/dcopiface/dcop-interface.html
  63
  64
  65 ** Documentation **
  66
  67 * For the translations :
  68 1. Download a patched gettext which can be found at:
  69  http://public.kde.planetmirror.com/pub/kde/devel/gettext-kde/
  70 2. Install that gettext in ~/bin/
  71 3. cd ~/yourproject, export PATH=~/bin:$PATH, export
  72 KDEDIR=/where_your_KDE3_is
  73 4. make -f admin/Makefile.common package-messages
  74 5. make package-messages
  75 6. Translate the po files (not the pot!!) with kbabel or xemacs
  76
  77 * Do not forget to write the documentation for your kde app
  78 edit the documentation template index.docbook in doc/
  79
  80
  81