diff options
Diffstat (limited to 'README.pyside6.md')
| -rw-r--r-- | README.pyside6.md | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/README.pyside6.md b/README.pyside6.md index 4a854ebcc..9178660d5 100644 --- a/README.pyside6.md +++ b/README.pyside6.md @@ -2,9 +2,11 @@ ### Introduction +**Important:** for Qt5 compatibility, check [PySide2](https://pypi.org/project/PySide2) + PySide6 is the official Python module from the -[Qt for Python project](http://wiki.qt.io/Qt_for_Python), -which provides access to the complete Qt 5.12+ framework. +[Qt for Python project](https://wiki.qt.io/Qt_for_Python), +which provides access to the complete Qt 6.0+ framework. The Qt for Python project is developed in the open, with all facilities you'd expect from any modern OSS project such as all code in a git repository and an open @@ -21,12 +23,17 @@ and [PyPi](https://pypi.org/project/PySide6/): pip install PySide6 ``` +> Please note: this wheel is an alias to other two wheels +> [PySide6_Essentials](https://pypi.org/project/PySide6_Essentials) and +> [PySide6_Addons](https://pypi.org/project/PySide6_Addons), which contains +> a predefined list of Qt Modules. + #### Dependencies -PySide6 versions following 5.12 use a C++ parser based on -[Clang](http://clang.org/). The Clang library (C-bindings), version 6.0 or +PySide6 versions following 6.0 use a C++ parser based on +[Clang](http://clang.org/). The Clang library (C-bindings), version 13.0 or higher is required for building. Prebuilt versions of it can be downloaded from -[download.qt.io](http://download.qt.io/development_releases/prebuilt/libclang/). +[download.qt.io](https://download.qt.io/development_releases/prebuilt/libclang/). After unpacking the archive, set the environment variable *LLVM_INSTALL_DIR* to point to the folder containing the *include* and *lib* directories of Clang: @@ -46,21 +53,20 @@ SET LLVM_INSTALL_DIR=%CD%\libclang ### Building from source For building PySide6 from scratch, please read about -[getting started](https://wiki.qt.io/Qt_for_Python/GettingStarted). +[getting started](https://doc.qt.io/qtforpython/gettingstarted.html). This process will include getting the code: ``` git clone https://code.qt.io/pyside/pyside-setup cd pyside-setup -git branch --track 5.14 origin/5.15 -git checkout 5.15 +git checkout 6.x # if a specific version is needed ``` then install the dependencies, and following the instructions per platform. A common build command will look like: ``` -python setup.py install --qmake=path/to/qmake/ --parallel=8 --build-tests +python setup.py install --qtpaths=/path/to/bin/qtpaths6 --parallel=8 --build-tests ``` You can obtain more information about the options to build PySide and Shiboken @@ -77,12 +83,12 @@ our [guidelines](https://wiki.qt.io/Qt_for_Python/Reporting_Bugs). ### Community -Check *#qt-pyside*, our official IRC channel on FreeNode, or contact us via our -[mailing list](http://lists.qt-project.org/mailman/listinfo/pyside). +Check our channels on IRC (Libera), Telegram, Gitter, Matrix, and mailing list, +and [join our community](https://wiki.qt.io/Qt_for_Python#Community)! ### Licensing -PySide6 is available under both Open Source (LGPLv3/GPLv2) and commercial -license. Using PyPi is the recommended installation source, because the -content of the wheels is valid for both cases. For more information, refer to +PySide6 is available under both Open Source (LGPLv3/GPLv3) and commercial +license. Using PyPi is the recommended installation source, because the +content of the wheels is valid for both cases. For more information, refer to the [Qt Licensing page](https://www.qt.io/licensing/). |