summaryrefslogtreecommitdiffstats
path: root/kab/README.KABAPI
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kab/README.KABAPI
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kab/README.KABAPI')
-rw-r--r--kab/README.KABAPI25
1 files changed, 25 insertions, 0 deletions
diff --git a/kab/README.KABAPI b/kab/README.KABAPI
new file mode 100644
index 000000000..278d787d2
--- /dev/null
+++ b/kab/README.KABAPI
@@ -0,0 +1,25 @@
+The KDE addressbook
+===================
+
+The kab API is a binary interface for application developers that want to
+use the users addressbook in their own applications. To use it, you have
+to link the binary of your program against "libkab.so", a DLL that exports
+kab's functions, and to include the header file "kabapi.h" in the KDE
+include directory into your sources.
+
+The documentation of the kab API is contained in the header file
+(kabapi.h), you can extract it by parsing the file with kdoc. The kab
+binary source directory in the kdeutils package contains a sample program
+that tries to explain some basic functions of the API. It is important
+that you report any bugs you find in the API or in the rest of kab to
+
+ mirko@kde.org
+
+Since it is used in different other applications, and I cannot imagine all
+the possible situations that might occur. Read the file README for some
+details about the compiler environment you need to get this sources
+compiled. Most of the possible problems should by now already be solved
+automatically by the automake script, but you need, for example, a C++
+compiler that handles templates properly.
+
+ Mirko Boehm, September 1998.