aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2014-03-27 16:51:35 +0100
committerJeremy Lainé <jeremy.laine@m4x.org>2014-03-27 16:51:35 +0100
commitb60a9072b658d6fd0363214c36bc3bbbaff6e1c3 (patch)
tree1d2bfeaf6685561f89d38b176cf22d4bb5eb94f7
parent0a9a3e8888bfed52d9f86a103e7430a44efd5025 (diff)
downloadqxmpp-b60a9072b658d6fd0363214c36bc3bbbaff6e1c3.tar.gz
rough conversion to markdown
-rw-r--r--README.md (renamed from README)22
1 files changed, 11 insertions, 11 deletions
diff --git a/README b/README.md
index 6bfe47c7..f5fabd4d 100644
--- a/README
+++ b/README.md
@@ -1,5 +1,7 @@
+[![Build Status](https://travis-ci.org/jlaine/qxmpp.png)](https://travis-ci.org/jlaine/qxmpp)
+
ABOUT QXMPP
------------
+===========
QXmpp is cross-platform C++ client library for XMPP. It is based on Qt.
@@ -7,7 +9,7 @@ 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 (with SSL enabled) to build the QXmpp.
The project uses qmake build system of Qt.
@@ -40,7 +42,7 @@ 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:
@@ -58,7 +60,7 @@ To link against the shared version of QXmpp, you need to add -DQXMPP_SHARED
to your C++ flags.
EXAMPLES
---------
+========
Look at the example directory for various examples.
@@ -67,7 +69,6 @@ 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
@@ -78,15 +79,14 @@ This is a full fledged Graphical XMPP client. This example will uses most of
the part of this library.
DOCUMENTATION
--------------
+=============
You can find information about QXmpp, on the project homepage:
https://github.com/jlaine/qxmpp
-
SUPPORTED PLATFORMS
--------------------
+===================
For this release, the following platforms have been tested:
@@ -109,7 +109,7 @@ You can do this by adding the following to your .pro file:
TARGET.CAPABILITY = "NetworkServices"
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
@@ -117,9 +117,9 @@ is already know at:
https://github.com/jlaine/qxmpp/issues
-
DISCUSSION GROUP
--------------------
+================
+
Join QXmpp Discussion Group for queries, discussions and updates.
http://groups.google.com/group/qxmpp