* Added command line tool example similar to 'sopranocmd'
[kdebindings.git] / README
blob87d1e89a46ba3d7216969e5ebee9df9bbb81ade7
1 In this file:
3 * Notes for end users
4 * Notes for developers
6 Notes for end users
7 -------------------
9 You only need this package when something else requires it.
11 Install examples:
12 # Compile and install
13 cmake -DCMAKE_INSTALL_PREFIX=/opt/kde4/ . && make && make install
14 # Compile with debugging enabled and point to the used ruby version
15 cmake -DCMAKE_BUILD_TYPE=debugfull -DRUBY_INCLUDE_PATH=/usr/lib/ruby/1.8/i486-linux/ -DRUBY_LIBRARY=/usr/lib/libruby1.8.so .
16 # Compile smokeqt but not smokekde
17 cmake -DENABLE_SMOKE=on -DENABLE_SMOKEKDE=off .
18 # Disable compiling of Qyoto
19 cmake -DENABLE_QYOTO=off .
20 # Disable compiling of QtRuby and Korundum
21 cmake -DENABLE_QTRUBY=off -DENABLE_KORUNDUM=off .
22 # Disable compiling of PyKDE
23 cmake -DENABLE_PYKDE4=off .
24 # Disable compiling of the Kross Ruby and Python backends
25 cmake -DENABLE_KROSSRUBY=off -DENABLE_KROSSPYTHON=off .
26 # Enable compiling of the Kross Java and Falcon backends
27 cmake -DENABLE_KROSSJAVA=on -DENABLE_KROSSFALCON=on .
29 Notes for developers
30 --------------------
32 This package contains:
33 * working:
34   * smoke: Language independent library for Qt and KDE bindings. Used by QtRuby, 
35     PerlQt and Qyoto.
36   * kalyptus: a header parser and bindings generator for Qt/KDE. Used for Smoke.
37   * qtruby: Qt bindings for Ruby
38   * korundum: KDE bindings for ruby
39   * Qyoto: Qt bindings for C#
40   * Kimono: KDE bindings for C#
41   * PyKDE: KDE bindings for python, requires PyQt from riverbankcomputing.co.uk
42   * KrossPython is the Python plugin for the kdelibs/kross scripting framework.
43   * KrossRuby is the Ruby plugin for the kdelibs/kross scripting framework.
44   * KrossJava is the Java plugin for the kdelibs/kross scripting framework.
45   * KrossFalcon is the Falcon (http://www.falconpl.org) plugin for the kdelibs/kross scripting framework.
47 * possibly broken: 
48   * xparts: allows you to embed non-KDE apps as a KPart
50 * obsolete:
51   * dcopperl: DCOP bindings for Perl
52     => perldbus
53   * kjsembed: javascript scripting support library for KDE applications
54     => moved to kdelibs
55   * qtjava: Qt bindings for Java JNI to use Qt/KDE classes with Java
56     => QtJambi
57   * kdejava: KDE bindings for Java JNI to use Qt/KDE classes with Java
58     => QtJambi
59   * dcoppython: DCOP bindings for Python
60     => pythondbus
61   * dcopc: DCOP bindings for C 
62     => qdbus
63   * dcopjava: DCOP bindings for JAVA
64     => QtJambi
65   * qtsharp: C# bindings for Qt
66     => Qyoto