* Add some missing classes to the Smoke library for the C# and Ruby bindings.
[kdebindings.git] / README
blobbb4d6051d050ea51f8bcbaf35b796a5d43c237ae
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 the Kross ruby and python backends
23 cmake -DENABLE_KROSSRUBY=off -DENABLE_KROSSPYTHON=off .
24 # Disable compiling of PyKDE
25 cmake -DENABLE_PYKDE4=off .
27 Notes for developers
28 --------------------
30 This package contains:
31 * working:
32   * smoke: Language independent library for Qt and KDE bindings. Used by QtRuby, 
33     PerlQt and Qyoto.
34   * kalyptus: a header parser and bindings generator for Qt/KDE. Used for Smoke.
35   * qtruby: Qt bindings for Ruby
36   * korundum: KDE bindings for ruby
37   * Qyoto: Qt bindings for C#
38   * Kimono: KDE bindings for C#
39   * PyKDE: KDE bindings for python, requires PyQt from riverbankcomputing.co.uk
40   * KrossPython is the Python plugin for the kdelibs/kross scripting framework.
41   * KrossRuby is the Ruby plugin for the kdelibs/kross scripting framework.
42   * KrossJava is the Java plugin for the kdelibs/kross scripting framework.
44 * possibly broken: 
45   * xparts: allows you to embed non-KDE apps as a KPart
47 * obsolete:
48   * dcopperl: DCOP bindings for Perl
49     => perldbus
50   * kjsembed: javascript scripting support library for KDE applications
51     => moved to kdelibs
52   * qtjava: Qt bindings for Java JNI to use Qt/KDE classes with Java
53     => QtJambi
54   * kdejava: KDE bindings for Java JNI to use Qt/KDE classes with Java
55     => QtJambi
56   * dcoppython: DCOP bindings for Python
57     => pythondbus
58   * dcopc: DCOP bindings for C 
59     => qdbus
60   * dcopjava: DCOP bindings for JAVA
61     => QtJambi
62   * qtsharp: C# bindings for Qt
63     => Qyoto