diff options
| author | Cristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2020-10-27 15:57:38 +0100 |
|---|---|---|
| committer | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2020-10-28 12:46:13 +0000 |
| commit | a26b04fae0f055d7590c9e7380afe7a5fb67c58e (patch) | |
| tree | 383503840a542040bb9d63e1b3216a2acec12d15 /README.shiboken6-generator.md | |
| parent | 2a2a0827fa54b2eeb48e0e2090dfc503492ef33e (diff) | |
doc: move setup.py docs and updates
* Moves the huge docstring from setup.py to the README.md file,
* Adding README.cmake.md as a new section of the README.md file,
* Update versioning and do partial updates respect to Qt 6
Change-Id: I4d97f14ebcc1e17fe349aaf5c68b4ce4505c882f
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'README.shiboken6-generator.md')
| -rw-r--r-- | README.shiboken6-generator.md | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/README.shiboken6-generator.md b/README.shiboken6-generator.md index 3b77edcf2..c57af2d94 100644 --- a/README.shiboken6-generator.md +++ b/README.shiboken6-generator.md @@ -1,34 +1,33 @@ # Shiboken6-generator -Shiboken is the generator used by the Qt for Python project. -It outputs C++ code for CPython extensions, which can be compiled -and transformed into a Python module. +Shiboken is the generator used by the Qt for Python project. It outputs C++ +code for CPython extensions, which can be compiled and transformed into +a Python module. -C++ projects based on Qt can be wrapped, but also projects -which are not related to Qt. +C++ projects based on Qt can be wrapped, but also projects which are not +related to Qt. ## How does it work? -Shiboken uses an API Extractor that does most of the job, -but it requires a typesystem (XML file) to customize how the -C++ classes/methods will be exposed to Python. +Shiboken uses an API Extractor that does most of the job, but it requires +a typesystem (XML file) to customize how the C++ classes/methods will be +exposed to Python. -The typesystem allows you to remove arguments from signatures, -modify return types, inject code and add conversion rules -from the C++ data types to Python data types, manipulate -the ownership of the objects, etc. +The typesystem allows you to remove arguments from signatures, modify return +types, inject code and add conversion rules from the C++ data types to Python +data types, manipulate the ownership of the objects, etc. # Examples -An example related to wrap a C++ library not depending on Qt -can be found in our [repository](https://code.qt.io/cgit/pyside/pyside-setup.git/tree/examples/samplebinding). +An example related to wrap a C++ library not depending on Qt can be found in +our [repository](https://code.qt.io/cgit/pyside/pyside-setup.git/tree/examples/samplebinding). Additionally, you can find a couple of tests inside the [git repository](https://code.qt.io/cgit/pyside/pyside-setup.git/tree/sources/shiboken6/tests). -For a more advanced case regarding extending a Qt/C++ application -with Python bindings based on the idea of the PySide module, -you can check the [scriptableapplication](https://code.qt.io/cgit/pyside/pyside-setup.git/tree/examples/scriptableapplication) +For a more advanced case regarding extending a Qt/C++ application with Python +bindings based on the idea of the PySide module, you can check the +[scriptableapplication](https://code.qt.io/cgit/pyside/pyside-setup.git/tree/examples/scriptableapplication) example in our repository. # Documentation |