aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md17
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.