aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2018-09-24 16:21:58 +0200
committerEike Ziller <eike.ziller@qt.io>2018-09-25 10:32:49 +0000
commit3c4cafdf834c9b683501efca72dbbe1093cf6f9a (patch)
tree5592398a8aec9e6b59afe17b048d8a7b32eff7a3 /README.md
parentee72345d6c4f7a576f25f3d04a24e4e49585397b (diff)
Allow single file extensions
Change-Id: I0b9e04e9ba2d73f43fbf08515366bfa303f2557b Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index 58f2ee5..709dbc8 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,10 @@
# Python Extensions for Qt Creator
This plugin for Qt Creator makes it possible to extend the Qt Creator by
-writing Python extensions. These extensions are simply Python packages,
-so they are directories containing a `__init__.py` and any other Python
-files necessary. They can be shared as zip archives, installed and managed
+writing Python extensions. These extensions are simply Python modules or
+packages, so they are either single Python files or directories containing a
+`__init__.py` and any other Python files necessary.
+They can be shared as zip archives, installed and managed
through the included extension manager (which is a Python extension itself) and
thus allow the Qt Creator to be easily extended with custom functionality.
@@ -129,9 +130,10 @@ The following process allows the plugin to work:
2. When Qt Creator is executed, the C++ plugin searches the standard
Qt Creator plugin directories for a directory named `python`, the
first directory found is the Python extension directory.
- Each python package in this directory represents it's own Python extension.
- Each package is loaded with `import`, which executes the initialization
- code in its `__init__.py`.
+ Each python module and package in this directory represents it's own Python
+ extension. Each extension is loaded with `import`, which executes the
+ module's initialization code (for extensions in the form of Python packages
+ that is the code in `__init__.py`).
3. Now all Python extensions have registered their actions / menus / etc.,
which can be triggered from the Qt Creator interface.