Warning, /games/ksudoku/src/README is written in an unsupported language. File is not indexed.

0001 -----------------------------------------------
0002 Kde application framework template quickstart
0003 2004-03-22: created by Thomas Nagy
0004 2006-11-13: adapted for cmake
0005 -----------------------------------------------
0006 
0007 This README file explains you basic things for starting with
0008 this application template.
0009 
0010 
0011 ** Building and installing **
0012 
0013 * Build the makefiles with "cmake ."
0014   (or better: create a directory (say build), and run in 
0015   that dir "cmake ..")
0016 * to change settings run "make edit_cache" (optional)
0017 * run "make"
0018 * run "make install"
0019 
0020 * To clean, use "make clean"
0021 
0022 For more make targets run "make help"
0023 
0024 
0025 
0026 ** Technologies **
0027 
0028 * Build the menus of your application easily
0029 kde applications now use an xml file (*ui.rc file) to build the menus.
0030 This allow a great customization of the application. However, when
0031 programming the menu is shown only after a "make install"
0032 
0033 For more details, consult :
0034 http://devel-home.kde.org/~larrosa/tutorial/p9.html
0035 http://developer.kde.org/documentation/tutorials/xmlui/preface.html
0036 
0037 * Use KConfig XT to create your configuration dialogs and make 
0038 them more maintainable.
0039 
0040 For more details, consult :
0041 http://developer.kde.org/documentation/tutorials/kconfigxt/kconfigxt.html
0042 
0043 * With KParts, you can embed other kde components in your program, or make your program
0044 embeddable in other apps. For example, the kmplayer kpart can be called to play videos
0045 in your app.
0046 
0047 For more details, consult :
0048 http://www-106.ibm.com/developerworks/library/l-kparts/
0049 http://developer.kde.org/documentation/tutorials/dot/writing-plugins.html
0050 http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html
0051 
0052 * With dcop, you can control your app from other applications
0053 Make sure to include K_DCOP and a kdcop: section in your .h file
0054 http://developer.kde.org/documentation/tutorials/dot/dcopiface/dcop-interface.html
0055 
0056 
0057 ** Documentation **
0058 
0059 * For the translations :
0060 1. Download a patched gettext which can be found at:
0061  http://public.kde.planetmirror.com/pub/kde/devel/gettext-kde/
0062 2. Install that gettext in ~/bin/
0063 3. cd ~/yourproject, export PATH=~/bin:$PATH, export
0064 KDEDIR=/where_your_KDE3_is
0065 4. make -f admin/Makefile.common package-messages
0066 5. make package-messages
0067 6. Translate the po files (not the pot!!) with kbabel or xemacs
0068 
0069 * Do not forget to write the documentation for your kde app 
0070 edit the documentation template index.docbook in doc/
0071 
0072 
0073