aboutsummaryrefslogtreecommitdiffstats
path: root/README.shiboken2.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.shiboken2.md')
-rw-r--r--README.shiboken2.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.shiboken2.md b/README.shiboken2.md
new file mode 100644
index 000000000..d9cd32a40
--- /dev/null
+++ b/README.shiboken2.md
@@ -0,0 +1,13 @@
+# shiboken2 module
+
+The purpose of the shiboken2 Python module 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/shiboken2/shibokenmodule.html)