Add a note about the python module version restriction

This commit is contained in:
baldurk
2020-07-24 16:33:21 +01:00
parent e147a5a6d1
commit 287bb81fca
2 changed files with 7 additions and 1 deletions
+2
View File
@@ -10,6 +10,8 @@ Within RenderDoc - when either running scripts on the command line, or via the :
It is also possible to build the ``renderdoc`` module standalone which can be loaded into python and used for scripting directly without the UI program. Due to the inherent difficulty of distributing C python modules this isn't included by default in distributed builds at the time of writing, but is generated by default in source builds - ``renderdoc.pyd`` on windows or ``renderdoc.so`` elsewhere.
You must use exactly the same version of python to load the module as was used to build it. On Windows the version of python that comes with the repository and is used by default is python 3.6.
.. note::
RenderDoc only supports Python 3.4+, Python 2 is not supported.