diff options
author | Tilman Roeder <tilman.roder@qt.io> | 2018-08-03 09:38:07 +0200 |
---|---|---|
committer | Tilman Roeder <tilman.roder@qt.io> | 2018-08-15 10:10:16 +0000 |
commit | 13e02b9aaea19ac21251d152a8fa69336ae76ebd (patch) | |
tree | a6320449c18251033d3a2557afaed6a8fcafbfc9 /docs/README.md | |
parent | efea0c2e4a2966d88f65cdab90f841f7905dee14 (diff) |
Initial commit
This is a quite large commit containing:
* The main extension that runs and initializes Python
* Some (example) bindings
* An initial build script for the main extension
* Optional binding and examples of how to create them
* An initial build script for the optional bindings
* A simple extension manager written in Python
* A few example Python extensions
* Some documentation (both in the code and as markdown files)
* A collection of helpful python scripts
* A small collection of unit tests
* A TODO list
For any additional details the code / docs should be consulted.
Change-Id: I3937886cfefa2f64d5a78013889a8e097eec8261
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..22fbe0e --- /dev/null +++ b/docs/README.md @@ -0,0 +1,17 @@ +# Documentation for Python Extensions + +This is the documentation for the QtCreator Python Extensions plugin. + +## Contents + 1. [Writing Python Extensions](./extensions.md) + 2. [The C++ PythonExtensionsPlugin](./plugin.md) + 3. [Build and Development Tools](./tools.md) + +## General overview + +Please refer to the section \`How it works' in the main [README.md](../README.md) file. + +## A Note regarding Python versions +In principle, the C++ plugin supports both Python 2 and 3 (at least for the versions tested, i.e. +2.7 and 3.5). However, the extensions themselves might only support one version of Python. This is +currently the case for the extension manager. |