From 6b4a8bfad12d371ea4e810ed9662b484fcc9326b Mon Sep 17 00:00:00 2001 From: Jeremy Lainé Date: Sun, 6 Apr 2014 12:25:38 +0200 Subject: include text from old homepage --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d6e5e8cc..cdc74d11 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,19 @@ ABOUT QXMPP =========== -QXmpp is cross-platform C++ client library for XMPP. It is based on Qt. +QXmpp is a cross-platform C++ XMPP client and server library. It is written +in C++ and uses the Qt framework. + +QXmpp strives to be as easy to use as possible, the underlying TCP socket, +the core XMPP RFCs (RFC3920 and RFC3921) and XMPP extensions have been +encapsulated into classes and functions. QXmpp comes with full API +documentation, automatic tests and numerous examples. + +QXmpp uses Qt extensively, and as such users need to a have working knowledge +of C++ and Qt basics (Signals and Slots and Qt data types). + +Qt is the only third party library which is required to build QXmpp, but +libraries such as speex and theora enable additional features. QXmpp is released under the terms of the GNU Lesser General Public License, version 2.1 or later. -- cgit v1.2.3 From 69d63d0d83d75b771e0c9d51e2c46c75da2daec1 Mon Sep 17 00:00:00 2001 From: Jeremy Lainé Date: Sun, 6 Apr 2014 12:28:10 +0200 Subject: add link to API docs --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index cdc74d11..c30ab153 100644 --- a/README.md +++ b/README.md @@ -93,9 +93,9 @@ the part of this library. DOCUMENTATION ============= -You can find information about QXmpp, on the project homepage: +You can find the API documentation for the latest QXmpp version here: -https://github.com/qxmpp-project/qxmpp +http://doc.qxmpp.org/qxmpp-snapshot/ SUPPORTED PLATFORMS =================== -- cgit v1.2.3 From 051295baa9c1a9cc953fece3d339f8174fb30127 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Fri, 18 Apr 2014 13:47:12 +0530 Subject: better language --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c30ab153..f792a13f 100644 --- a/README.md +++ b/README.md @@ -100,8 +100,12 @@ http://doc.qxmpp.org/qxmpp-snapshot/ SUPPORTED PLATFORMS =================== -For this release, the following platforms have been tested: +It should work on all the plaforms supported by Qt. For a complete list of +platforms support by Qt, see: +http://qt-project.org/doc/supported-platforms.html + +In past, we have tested on variety of platforms: win32-g++ (Qt SDK) win32-msvc2008 (Qt MSVC-2008) win64-msvc2008 (Qt MSVC-2008) @@ -109,11 +113,6 @@ For this release, the following platforms have been tested: 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://qt-project.org/doc/supported-platforms.html - 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: -- cgit v1.2.3 From 15b93f1a1a6d0cafa6883b57197ce00f422563ae Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Fri, 18 Apr 2014 13:56:31 +0530 Subject: minor changes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f792a13f..0c060086 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ ABOUT QXMPP =========== QXmpp is a cross-platform C++ XMPP client and server library. It is written -in C++ and uses the Qt framework. +in C++ and uses Qt framework. QXmpp strives to be as easy to use as possible, the underlying TCP socket, the core XMPP RFCs (RFC3920 and RFC3921) and XMPP extensions have been -encapsulated into classes and functions. QXmpp comes with full API -documentation, automatic tests and numerous examples. +nicely encapsulated into classes. QXmpp comes with full API +documentation, automatic tests and many examples. QXmpp uses Qt extensively, and as such users need to a have working knowledge of C++ and Qt basics (Signals and Slots and Qt data types). -- cgit v1.2.3 From 2ba4aa2e2fff0954e07c8b7c4520a52bd6debf47 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Fri, 18 Apr 2014 14:09:38 +0530 Subject: rewording --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0c060086..39056338 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,8 @@ 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. +QXmpp requires Qt 4.5 or higher (with SSL enabled) and it uses +the standard qmake build system of Qt. Building from the command line: -- cgit v1.2.3 From 973ae5f972fbc0b9ed3b37b22235f1c52b0e2901 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Fri, 18 Apr 2014 14:13:35 +0530 Subject: fix grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 39056338..3f6a59b3 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ 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. -Building using Qt Creator: +Build using Qt Creator: Open the qxmpp.pro file in Qt Creator and hit "Build All" to build all the examples and library. -- cgit v1.2.3 From 09d9b66fa19ecc21532d8c5dcf81677fb59c2de9 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Fri, 18 Apr 2014 14:45:32 +0530 Subject: minor change --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3f6a59b3..4d89876a 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ BUILDING QXMPP QXmpp requires Qt 4.5 or higher (with SSL enabled) and it uses the standard qmake build system of Qt. -Building from the command line: +Build from command line: cd qmake -- cgit v1.2.3 From 5c7da83e374d85455781dce49b731c9b7d700c37 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Fri, 18 Apr 2014 16:07:24 +0530 Subject: fix markdown --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 4d89876a..489b83f5 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,7 @@ platforms support by Qt, see: http://qt-project.org/doc/supported-platforms.html In past, we have tested on variety of platforms: + win32-g++ (Qt SDK) win32-msvc2008 (Qt MSVC-2008) win64-msvc2008 (Qt MSVC-2008) -- cgit v1.2.3 From e9857606ce122e38c75d287f061379dbca62b97d Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Fri, 18 Apr 2014 19:16:20 +0530 Subject: more changes and fix markdown --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 489b83f5..48bdfb71 100644 --- a/README.md +++ b/README.md @@ -56,10 +56,11 @@ the examples and library. INSTALLING QXMPP ================ -After building QXmpp the you can install the Headers, Libraries +After building QXmpp, you can install the Headers, Libraries and Documentation using the following command: -Installing from the command line: +Install from command line: + install Path of installations: -- cgit v1.2.3 From c94d62a1df697b2ab7701f89c1aaa9b4c981ad0f Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Fri, 18 Apr 2014 19:19:02 +0530 Subject: there are more examples --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 48bdfb71..30a1cc05 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,8 @@ to your C++ flags. EXAMPLES ======== -Look at the example directory for various examples. +Look at the example directory for various examples. Here is a description of +a few. * *example_0_connected* This example just connects to the xmpp server and start receiving presences -- cgit v1.2.3