aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2018-09-17 10:22:46 +0200
committerEike Ziller <eike.ziller@qt.io>2018-09-17 10:52:31 +0000
commiteba547cccf4d29b8622fd1ef7b14ed91956b3ca4 (patch)
treeb3859c33940354e3389b386d6eb500158f640bdc /README.md
parent0f35a83f35f9f785a67a5989dccc11c4828795b6 (diff)
The product name is "Qt Creator" with a space
Change-Id: I6716ab0b26f8881e07580df19bc29dd3c3146ae7 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/README.md b/README.md
index 4e3886c..58f2ee5 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
-# Python Extensions for QtCreator
+# Python Extensions for Qt Creator
-This plugin for QtCreator makes it possible to extend the QtCreator by
+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
through the included extension manager (which is a Python extension itself) and
-thus allow the QtCreator to be easily extended with custom functionality.
+thus allow the Qt Creator to be easily extended with custom functionality.
**WARNING:** This is a first draft / proof of concept and only offers
very limited functionality. There will still be many bugs and so far
@@ -26,7 +26,7 @@ This repository contains the following:
## Installation instructions
Note that this process has so far only be tested on Linux. The plugin
-itself has only been tested with Python 3.5 and 2.7.12 and QtCreator
+itself has only been tested with Python 3.5 and 2.7.12 and Qt Creator
4.7.82.
### Installing dependencies
@@ -35,7 +35,7 @@ need to install [PySide2](https://pyside.org) for the version of
Python you plan to use. This is necessary, as the plugin uses the
system installed Python (or the Python installed in your virtual env,
if you have one set up) and it's packages. You will also need to build
-your own version of QtCreator and require a Qt installation. (This
+your own version of Qt Creator and require a Qt installation. (This
project has so far only been tested with Qt5.11.0.)
To obtain the required Qt version, you can either build Qt yourself,
@@ -58,7 +58,7 @@ you will encounter errors when parsing / compiling this project. To
get these patches, you will probably need to build Shiboken from
source.
-To build QtCreator, which is necessary for building the plugin, please refer to their
+To build Qt Creator, which is necessary for building the plugin, please refer to their
[build instructions](https://doc-snapshots.qt.io/qtcreator-extending/getting-and-building.html).
### Building the C++ plugin and bindings
@@ -69,7 +69,7 @@ bindings and the plugin itself.
$ path/to/your/qmake
$ make
```
-After this, the plugin should be installed into the QtCreator version
+After this, the plugin should be installed into the Qt Creator version
you built in the previous steps. If this worked, you can now go ahead
and check out the `examples` folder and play with the provided example
Python extensions.
@@ -83,7 +83,7 @@ following before building the plugin:
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/clang/lib
```
-You may need to expose your QtCreator sources like this:
+You may need to expose your Qt Creator sources like this:
```
export QTC_SOURCE=/path/to/your/qt-creator
export QTC_BUILD=/path/to/your/qt-creator
@@ -91,7 +91,7 @@ export QTC_BUILD=/path/to/your/qt-creator
**NOTICE:** This plugin generates a few debug messages and potential
warnings. Any Python extension that is installed might also write
-output to stdout. To see these messages, you can execute QtCreator
+output to stdout. To see these messages, you can execute Qt Creator
from your terminal by running the executable there.
### What to do if it didn't work?
@@ -118,7 +118,7 @@ in this list (or in the build system).
## How it works
In a nutshell, this project generates Python bindings for the
-QtCreator using Shiboken and then executes python scripts it finds in
+Qt Creator using Shiboken and then executes python scripts it finds in
a bespoke directory.
The following process allows the plugin to work:
@@ -126,14 +126,14 @@ The following process allows the plugin to work:
1. At compile time, Shiboken generates a huge amount of C++ code that
allows a few classes from the Core plugin and utils library to be
accessed from Python.
- 2. When QtCreator is executed, the C++ plugin searches the standard
- QtCreator plugin directories for a directory named `python`, the
+ 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`.
3. Now all Python extensions have registered their actions / menus / etc.,
- which can be triggered from the QtCreator interface.
+ which can be triggered from the Qt Creator interface.
When executed, the Python extensions can import any modules / packages
installed for the system Python, in Qt Creator's extensions directory, or