diff --git a/doc/source/developer_information/ide_support/20_qt_creator.rst b/doc/source/developer_information/ide_support/20_qt_creator.rst index 240ba0b047876e1bd2482200f55df72aefd79413..fc3a9f2272a9d4c1039b28ba87df7cf12ffbce89 100644 --- a/doc/source/developer_information/ide_support/20_qt_creator.rst +++ b/doc/source/developer_information/ide_support/20_qt_creator.rst @@ -59,6 +59,9 @@ Setup CMake-Kit :align: center :scale: 60% + When loading a ``CMakeLists.txt`` doesn't result in listing all relevant files, a change of the ``CMake Generator`` to ``MinGW Makefiles`` with a matching ``Extra generator`` is recommended. + This has to be noted while executing the ``Prepare build`` step in :ref:`Installing OpenPASS `. + .. note:: Change the environment variable to ``MAKEFLAGS=-j4`` (or similar) to enable parallel building on the kit level. @@ -68,7 +71,8 @@ Setup Project #. Load the project by opening a ``CMakeLists.txt`` file and configure it to use the new kit. -#. Setup missing CMake flags (c.f. :ref:'CMake') +#. Setup missing CMake flags (c.f. :ref:`Cmake`). + For building the documentation and also running the end-to-end tests the variable ``Python3_EXECUTABLE`` needs to be set to a native Windows Python environment, which has to include all required libraries, because the Python environment used in MSYS2 will not work here. .. todo:: @@ -90,7 +94,7 @@ Setup Project #. Load the project by opening a ``CMakeLists.txt`` file and configure it to use a proper kit. -#. Setup missing CMake flags (c.f. :ref:'CMake') +#. Setup missing CMake flags (c.f. :ref:`Cmake`) .. todo:: @@ -112,7 +116,8 @@ Alternative Method - Execute the step for ``build-debug`` #. Open Qt Creator #. Open ``CMakeLists.txt`` -#. Qt Creator should find the configured build directories and create a temporary kit +#. Qt Creator should find the configured build directories and create a temporary kit. + It is recommended to use the the Kit prepared under the step ``Setup CMake-Kit`` and change therefore the paths for the ``Release`` resp. ``Debug`` build from the ``Prepare build`` step in :ref:`Installing OpenPASS `. .. figure:: _static/images/qtcreator_project_cmake.png :align: center @@ -125,3 +130,15 @@ Alternative Method .. figure:: _static/images/qtcreator_project_cmake_settings.png :align: center :scale: 60% + + It is possible to add an additional build step which also includes the end-to-end tests. Therefore the CMake variable ``WITH_ENDTOEND_TESTS`` needs to be set. + + .. figure:: _static/images/qtcreator_adding_build_steps.png + :align: center + :scale: 60% + +#. After the build, the link to the ``opSimulation.exe`` resp. the ``opSimulationManager.exe`` within the ``Run Settings`` is possible. When using ``Debug`` as the build-type, the Qt-creator should be able to run the simulation with debugging. + + .. figure:: _static/images/qtcreator_adding_run_configuration.png + :align: center + :scale: 60% \ No newline at end of file diff --git a/doc/source/developer_information/ide_support/_static/images/qtcreator_adding_build_steps.png b/doc/source/developer_information/ide_support/_static/images/qtcreator_adding_build_steps.png new file mode 100644 index 0000000000000000000000000000000000000000..a9dd6cf9d6dec7de94203043021c05ade5a94700 Binary files /dev/null and b/doc/source/developer_information/ide_support/_static/images/qtcreator_adding_build_steps.png differ diff --git a/doc/source/developer_information/ide_support/_static/images/qtcreator_adding_run_configuration.png b/doc/source/developer_information/ide_support/_static/images/qtcreator_adding_run_configuration.png new file mode 100644 index 0000000000000000000000000000000000000000..6522b20ef028b99a10dbbbcc29f8dfc3f132e123 Binary files /dev/null and b/doc/source/developer_information/ide_support/_static/images/qtcreator_adding_run_configuration.png differ