aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2014-03-27 16:53:51 +0100
committerJeremy Lainé <jeremy.laine@m4x.org>2014-03-27 16:53:51 +0100
commit5c84253fc60c4ed60ff7c86237532c1ff9dea7ed (patch)
tree7e8e1e0023ee370d4c6723e4b414d6712598a5ef /README.md
parentb60a9072b658d6fd0363214c36bc3bbbaff6e1c3 (diff)
improve markdown
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 23 insertions, 23 deletions
diff --git a/README.md b/README.md
index f5fabd4d..b8741fa7 100644
--- a/README.md
+++ b/README.md
@@ -16,21 +16,21 @@ The project uses qmake build system of Qt.
Building from the command line:
-cd <where qxmpp.pro is located>
-qmake <arguments>
-<respective-make-cmd = gmake, make, mingw32-make, nmake>
+ cd <where qxmpp.pro is located>
+ qmake <arguments>
+ <respective-make-cmd = gmake, make, mingw32-make, nmake>
You can pass the following arguments to qmake:
- PREFIX=<prefix> to change the install prefix
- default:
- unix: /usr/local on unix
- other: $$[QT_INSTALL_PREFIX]
- QXMPP_AUTOTEST_INTERNAL=1 to enabled internal autotests
- QXMPP_LIBRARY_TYPE=staticlib to build a static version of QXmpp
- QXMPP_USE_SPEEX=1 to enable speex audio codec
- QXMPP_USE_THEORA=1 to enable theora video codec
- QXMPP_USE_VPX=1 to enable vpx video codec
+ PREFIX=<prefix> to change the install prefix
+ default:
+ unix: /usr/local on unix
+ other: $$[QT_INSTALL_PREFIX]
+ QXMPP_AUTOTEST_INTERNAL=1 to enabled internal autotests
+ QXMPP_LIBRARY_TYPE=staticlib to build a static version of QXmpp
+ QXMPP_USE_SPEEX=1 to enable speex audio codec
+ QXMPP_USE_THEORA=1 to enable theora video codec
+ QXMPP_USE_VPX=1 to enable vpx video codec
Note: by default QXmpp is built as a shared library. If you decide to build
a static library instead, you will need to pass -DQXMPP_STATIC when building
@@ -48,7 +48,7 @@ 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
+ <respective-make-cmd = gmake, make, mingw32-make, nmake> install
Path of installations:
@@ -64,17 +64,17 @@ EXAMPLES
Look at the example directory for various examples.
-* example_0_connected
+* *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
+* *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.
-* GuiClient
+* *GuiClient*
This is a full fledged Graphical XMPP client. This example will uses most of
the part of this library.
@@ -90,12 +90,12 @@ SUPPORTED PLATFORMS
For this release, the following platforms have been tested:
- win32-g++ (Qt SDK)
- win32-msvc2008 (Qt MSVC-2008)
- win64-msvc2008 (Qt MSVC-2008)
- symbian-gcce (Nokia Qt SDK)
- linux-g++ (32-bit and 64-bit)
- macos-g++ (32-bit and 64-bit)
+ win32-g++ (Qt SDK)
+ win32-msvc2008 (Qt MSVC-2008)
+ win64-msvc2008 (Qt MSVC-2008)
+ 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:
@@ -106,7 +106,7 @@ Please note that on Symbian, you will need to make sure your add the
"NetworkServices" to your application to enable it to access the network.
You can do this by adding the following to your .pro file:
- TARGET.CAPABILITY = "NetworkServices"
+ TARGET.CAPABILITY = "NetworkServices"
HOW TO REPORT A BUG
===================