summaryrefslogtreecommitdiffstats
path: root/development/shiboken2/README
diff options
context:
space:
mode:
Diffstat (limited to 'development/shiboken2/README')
-rw-r--r--development/shiboken2/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/development/shiboken2/README b/development/shiboken2/README
new file mode 100644
index 0000000000..ba1c0dd723
--- /dev/null
+++ b/development/shiboken2/README
@@ -0,0 +1,11 @@
+Shiboken is a fundamental piece on the Qt for Python project that
+serves two purposes:
+
+- Generator: Extract information from C or C++ headers and generate
+ CPython code that allow to bring C or C++ projects to Python. This
+ process uses a library called ApiExtractor which internally uses
+ Clang.
+
+- Module: An utility Python module that exposed new Python types,
+ functions to handle pointers, among other things, that is written in
+ CPython and can be used independently of the generator.