aboutsummaryrefslogtreecommitdiffstats
path: root/README.shiboken6.md
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2020-10-28 07:51:22 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2020-10-28 09:34:35 +0000
commit2a2a0827fa54b2eeb48e0e2090dfc503492ef33e (patch)
tree4311f7ad34ff98fabcbe4c34e59a970ae4ff4bcf /README.shiboken6.md
parentfb1c0f204e09ba29fa3d360d72231d4ed468c1e4 (diff)
Rename shiboken2 to shiboken6
Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I4cb5ee4c8df539546014b08202a7b1e98ed3ff07 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'README.shiboken6.md')
-rw-r--r--README.shiboken6.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.shiboken6.md b/README.shiboken6.md
new file mode 100644
index 000000000..2040f481d
--- /dev/null
+++ b/README.shiboken6.md
@@ -0,0 +1,13 @@
+# Shiboken6 module
+
+The purpose of the [shiboken6 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.
+
+Mostly the idea is to interact with Shiboken objects,
+where one can check if it is valid, or if the generated Python wrapper
+is invalid after the underlying C++ object has been destroyed.
+
+More information on the available functions can be found
+in our [official documentation](https://doc.qt.io/qtforpython/shiboken6/shibokenmodule.html)