ABOUT QXMPP
-----------

QXmpp is cross-platform C++ client library for XMPP. It is based on Qt.

QXmpp is released under the terms of the GNU Lesser General Public License,
version 2.1 or later.

BUILDING QXMPP
--------------

You need to have Qt 4.5 or higher to build the QXmpp.
The project uses qmake build system of Qt.

Building from the command line:

cd <where qxmpp.pro is located>
qmake
<respective-make-cmd = gmake, make, mingw32-make, nmake>

Building using Qt Creator:

Open the qxmpp.pro file in Qt Creator and hit "Build All" to build all
the examples and library.

INSTALLING QXMPP
--------------

After building QXmpp the you can install the Headers, Libraries 
and Documentation using the following command:

Installing from the command line:
<respective-make-cmd = gmake, make, mingw32-make, nmake> install

Path of installations:
    Linux:
    -----
    Headers:            /usr/include/qxmpp
    Static Library:     /usr/lib
    API Documentation:  /usr/share/doc/qxmpp

    Windows: [Note much of use though]
    -----
    Headers:            %QTDIR%\include\qxmpp
    Static Library:     %QTDIR%\lib
    API Documentation:  %QTDIR%\share\doc\qxmpp\html


EXAMPLES
--------

Have a look the available examples to start using this library. Logging has
been set to stdout so you can see the progress on the command line.

* example_0_connected

This example just connects to the xmpp server and start receiving presences
(updates) from the server. After running this example, you can see this user
online, if it's added in your roster (friends list).


* example_1_echoClient

This is a very simple bot which echoes the message sent to it. Run this
example, send it a message from a friend of this bot and you will
receive the message back. This example shows how to receive and send messages.


DOCUMENTATION
-------------

You can find information about QXmpp, on the project homepage:

http://code.google.com/p/qxmpp


SUPPORTED PLATFORMS
-------------------

For this release, the following platforms have been tested:

  win32-g++        (Qt SDK)
  symbian-gcce     (Nokia Qt SDK)
  linux-g++        (32-bit and 64-bit)
  macos-g++        (32-bit and 64-bit)

It should work on all the plaforms supported by Qt. For a complete list of
platforms support by Qt, see:

http://doc.qt.nokia.com/supported-platforms.html


HOW TO REPORT A BUG
-------------------

If you think you have found a bug in QXmpp, we would like to hear about
it so that we can fix it. Before reporting a bug, please check if the issue
is already know at:
 
http://code.google.com/p/qxmpp/issues/