Rename many classes to avoid conflicts with KDE

1 files changed, 50 insertions, 0 deletions

diff --git a/tdejava/README b/tdejava/README
new file mode 100644
index 00000000..a18d7558
--- /dev/null
+++ b/tdejava/README
@@ -0,0 +1,50 @@
+/***************************************************************************
+ * 	(C) 2000-2003 Lost Highway Ltd. All rights reserved.               *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU Library General Public License as       *
+ *   published by the Free Software Foundation; either version 2 of the    *
+ *   License, or (at your option) any later version.                       *
+ *                                                                         *
+ ***************************************************************************/
+
+Here are Java JNI based api bindings for KDE 3.2.
+
+All the C++/Java files in this project are generated from the KDE 3.2 C++ headers,
+apart from the following:
+
+TDESupport.cpp
+TDESupport.h
+	C++ static type conversion methods; Java <--> C++
+
+BUILD INSTRUCTIONS
+
+1)  Ensure that the tdebindings/qtjava project has been built first.
+    $ cd tdebindings/tdejava
+    $ make
+    $ make install
+
+  The koala.jar file is installed in $(kde_libraries)/java.You will need to add
+  qtjava.jar and koala.jar to your classpath.
+
+2) That's it - you should be able to compile and run the Java example
+   tdejava/koala/examples/kscribble by typing:
+
+	$ javac *.java
+	$ java Main
+
+3) If you wish to write KDE Java applications, include the following in the class which has a main() function:
+
+	static {
+		qtjava.initialize();
+		tdejava.initialize();
+	}
+
+It will load the KDE Java 'libtdejava.so' and 'libqtjava.so' shared libraries
+
+4)
+# Generate documentation
+cd tdejava/koala/api
+javadoc -classpath "../koala.jar:../../../qtjava/javalib/qtjava.jar" \
+  -author -version -splitindex -windowtitle  "Koala KDE 3.2 Java api" ../org/trinitydesktop/koala/*.java -J-Xmx128m
+