diff options
| author | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2019-01-11 12:34:08 +0100 |
|---|---|---|
| committer | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2019-01-11 14:47:51 +0000 |
| commit | b33f8708fd1d9aee7e4409a91b96fe96d3730764 (patch) | |
| tree | dbe8873ec56cc66bc65aeaa104252b2e7154646e | |
| parent | 779a42b15f3245710d58bdefc2e0388191e4f364 (diff) | |
Update READMEs
A couple of details were fixed:
* the --jobs option that is now --parallel,
* don't mention shiboken on the PySide2 wheel,
* add a shiboken wiki page link,
* among others
Change-Id: I6e1ae7375bd425c2e0357a03e976ea70c7b05e1d
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
| -rw-r--r-- | README.pyside2.md | 12 | ||||
| -rw-r--r-- | README.shiboken2-generator.md | 2 | ||||
| -rw-r--r-- | README.shiboken2.md | 6 |
3 files changed, 10 insertions, 10 deletions
diff --git a/README.pyside2.md b/README.pyside2.md index 53f7bc9d0..f1bd8aaa4 100644 --- a/README.pyside2.md +++ b/README.pyside2.md @@ -2,11 +2,11 @@ ### Introduction -PySide is the [Python Qt bindings project](http://wiki.qt.io/Qt_for_Python), -providing access to the complete Qt 5.12+ framework as well as to generator -tools for rapidly generating Python bindings for any C++ libraries. +PySide2 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. -The PySide project is developed in the open, with all facilities you'd expect +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 design process. We welcome any contribution conforming to the [Qt Contribution Agreement](https://www.qt.io/contributionagreement/). @@ -21,7 +21,7 @@ and [PyPi](https://pypi.org/project/PySide2/): #### Dependencies -PySide versions following 5.12 use a C++ parser based on +PySide2 versions following 5.12 use a C++ parser based on [Clang](http://clang.org/). The Clang library (C-bindings), version 6.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/). @@ -51,7 +51,7 @@ This process will include getting the code: 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/> --jobs=8 --build-tests + python setup.py install --qmake=<path/to/qmake/> --parallel=8 --build-tests You can obtain more information about the options to build PySide and Shiboken in [our wiki](https://wiki.qt.io/Qt_for_Python/). diff --git a/README.shiboken2-generator.md b/README.shiboken2-generator.md index f29f40634..a7fd32244 100644 --- a/README.shiboken2-generator.md +++ b/README.shiboken2-generator.md @@ -1,4 +1,4 @@ -# shiboken2-generator +# Shiboken2-generator Shiboken is the generator used by the Qt for Python project. It outputs C++ code for CPython extensions, which can be compiled diff --git a/README.shiboken2.md b/README.shiboken2.md index d9cd32a40..3d92f2a46 100644 --- a/README.shiboken2.md +++ b/README.shiboken2.md @@ -1,7 +1,7 @@ -# shiboken2 module +# Shiboken2 module -The purpose of the shiboken2 Python module is to access information -related to the binding generation that could be used to integrate +The purpose of the [shiboken2 Python module](https://wiki.qt.io/Qt_for_Python/Shiboken) +is to access information related to the binding generation that could be used to integrate C++ programs to Python, or even to get useful information to debug an application. |