aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNiels Ole Salscheider <niels_ole@salscheider-online.de>2017-09-04 13:09:13 +0200
committerNiels Ole Salscheider <niels_ole@salscheider-online.de>2017-09-04 20:34:53 +0200
commitdc438e24cd9c6c6017806ef0efaf051395e4086c (patch)
tree0927e605230b9f39df4537d21bc5a1ad2ebc3028 /README.md
parent284e9ef7866a0cd12ffeb847d95f76222c8eaed7 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 13 insertions, 34 deletions
diff --git a/README.md b/README.md
index 88d78b48..e14a2e99 100644
--- a/README.md
+++ b/README.md
@@ -23,37 +23,25 @@ version 2.1 or later.
BUILDING QXMPP
==============
-QXmpp requires Qt 4.5 or higher (including Qt 5.x) with SSL enabled and it uses
-the standard qmake build system of Qt.
+QXmpp requires Qt 5.0 or higher with SSL enabled.
+It uses CMake as build system.
Build from command line:
- cd <where qxmpp.pro is located>
- qmake <arguments>
+ mkdir build
+ cd build
+ cmake ..
<respective-make-cmd = gmake, make, mingw32-make, nmake>
-You can pass the following arguments to qmake:
+You can pass the following arguments to CMake:
- 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_DOXYGEN=1 to build the HTML documentation
- QXMPP_USE_OPUS=1 to enable opus audio codec
- 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
-your programs against QXmpp.
-
-Build using Qt Creator:
-
-Open the qxmpp.pro file in Qt Creator and hit "Build All" to build all
-the examples and library.
+ BUILD_DOCUMENTATION to build the documentation
+ BUILD_EXAMPLES to build the examples
+ BUILD_TESTS to build the unit tests
+ WITH_OPUS to enable opus audio codec
+ WITH_SPEEX to enable speex audio codec
+ WITH_THEORA to enable theora video codec
+ WITH_VPX to enable vpx video codec
INSTALLING QXMPP
================
@@ -65,15 +53,6 @@ Install from command line:
<respective-make-cmd = gmake, make, mingw32-make, nmake> install
-Path of installations:
-
- Headers: PREFIX/include/qxmpp
- Library: PREFIX/lib
- API Documentation: PREFIX/share/doc/qxmpp
-
-To link against the shared version of QXmpp, you need to add -DQXMPP_SHARED
-to your C++ flags.
-
EXAMPLES
========