diff options
| author | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2018-10-17 11:20:44 +0200 |
|---|---|---|
| committer | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2018-10-22 10:33:13 +0000 |
| commit | 3d6fc64570024d6af11597bb2ee4d431600ec6e1 (patch) | |
| tree | 5be94b0f37fc50d92d5510b2646a1618f1a44860 /README.shiboken2.md | |
| parent | f595aa5d9d45bc772d2e9aea24f44dc5d43c45be (diff) | |
Update README files for the project
After the split related to building the project
three README files are required to describe each component:
PySide2, Shiboken2-Generator and Shiboken2 (module).
For PySide2 and Shiboken2 (module) the README will also
be the project description on PyPi.
Change-Id: I3a2c3fe7fcfdbef696ffe77d5f1e6ba34f9f9b23
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'README.shiboken2.md')
| -rw-r--r-- | README.shiboken2.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/README.shiboken2.md b/README.shiboken2.md index f98f63c57..d9cd32a40 100644 --- a/README.shiboken2.md +++ b/README.shiboken2.md @@ -1 +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) |