diff options
author | Mårten Nordheim <marten.nordheim@qt.io> | 2023-10-04 19:56:21 +0200 |
---|---|---|
committer | Mårten Nordheim <marten.nordheim@qt.io> | 2023-10-30 16:29:13 +0000 |
commit | d310ecb8709a59850a46c33aff64f06b8bcf82ea (patch) | |
tree | 9aebec22541ab5920e532ef473659e4bdce899ad /README.md | |
parent | 586cffb6d6cb42dd73c1217ec1eac84104b4d846 (diff) |
Update README.md to match the new template
It was still referencing Qt 5 and qmake.
Pick-to: 6.6 6.5
Change-Id: Icc1716e4808f60fc6a91b8841eadbc221fc9acfc
Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io>
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 60 |
1 files changed, 43 insertions, 17 deletions
@@ -1,34 +1,60 @@ -### Introduction +## Qt WebSockets + +### Package Brief + `QtWebSockets` is a pure Qt implementation of WebSockets - both client and server. -It is implemented as a Qt add-on module, that can easily be embedded into existing Qt projects. It has no other dependencies than Qt. +It is implemented as a Qt add-on module that can easily be embedded into existing Qt projects. +Its only dependency is Qt. + +### Documentation + +The documentation can be found in the following places: +* The online Qt documentation: + * [Qt WebSockets documentation](https://doc.qt.io/qt-6/qtwebsockets-index.html) +* Build from source: + * [Building Qt Documentation](https://wiki.qt.io/Building_Qt_Documentation) + +*Note that the documentation links in this document will always be for the +latest Qt 6 version. If you need to browse the documentation for a specific +version, you can [browse the archives](https://doc.qt.io/archives/).* ### Features + * Client and server capable * Text and binary sockets * Frame-based and message-based signals * Strict Unicode checking * WSS and proxy support -### Requirements -Qt 5.x +### Compliance + +`QtWebSockets` is compliant with [RFC6455](http://datatracker.ietf.org/doc/rfc6455/?include_text=1) and has been tested with the [Autobahn Testsuite](http://autobahn.ws/testsuite). + +### Missing Features -### Build And Usage -Checkout the source code from code.qt.io -Go into the source directory and execute: +* Extensions - qmake - make - make install +### Build Process +Building the package/repository does depend on the Qt packages listed in dependencies.yaml. +Further dependencies to system packages are listed in the configure output. -The last command will install `QtWebSockets` as a Qt module. +See the [documentation](https://doc.qt.io/qt-6/build-sources.html) for general +advice on building the Qt framework and its modules from sources. Further +information on how to build from source is also available in the +[wiki](https://wiki.qt.io/Building_Qt_6_from_Git). -To use, add `websockets` to the QT variable. +### Report an Issue -`QT += websockets` +If you spot a bug, follow [these](https://doc.qt.io/qt-6/bughowto.html) +steps to report it. -### Compliance -`QtWebSockets` is compliant with [RFC6455](http://datatracker.ietf.org/doc/rfc6455/?include_text=1) and has been tested with the [Autobahn Testsuite](http://autobahn.ws/testsuite). +### Contribute to Qt -### Missing Features -* Extensions +We welcome contributions to Qt! If you'd like to contribute, read the +[Qt Contribution Guidelines](https://wiki.qt.io/Qt_Contribution_Guidelines). + +### Licensing + +Qt is available under various licenses. For details, check out the +[license documentation](https://doc.qt.io/qt-6/licensing.html). |