Add runtime build instructions to docs

Task-number: QT3DS-3691
Change-Id: Ib1239fd53f6b48963109c6e9d5b7a10e1c075795
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Reviewed-by: Pasi Keränen <pasi.keranen@qt.io>
 

17 files changed, 360 insertions, 0 deletions

diff --git a/src/api/studio3d/doc/src/building-embedded.qdoc b/src/api/studio3d/doc/src/building-embedded.qdoc
new file mode 100644
index 0000000..ddd8b59
--- /dev/null
+++ b/src/api/studio3d/doc/src/building-embedded.qdoc
@@ -0,0 +1,82 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+
+\title Building \RUNTIME for Embedded Linux
+\page building-opengl-runtime-embedded-linux.html
+
+Before you build the \RUNTIME for Embedded Linux, you will need to install Qt for Embedded Linux.
+
+\section1 Install Qt for Embedded Linux
+Follow the Installation guide for your specific target device.
+
+\section1 Build the \RUNTIME
+
+\list 1
+  \li
+    Clone the \RUNTIME repository from
+    \l {https://code.qt.io/cgit/qt3dstudio/ogl-runtime.git}.
+    You can clone the repo with the \c {git clone} command:
+    \badcode
+    git clone git://code.qt.io/qt3dstudio/ogl-runtime.git
+    \endcode
+
+    \note If you want to use the HTTPS protocol, you can clone the \RUNTIME repo with the
+    following command:
+    \badcode
+    git clone https://code.qt.io/qt3dstudio/ogl-runtime.git
+    \endcode
+  \li
+    Run the following \c{git submodule} command:
+    \badcode
+    git submodule update --init --recursive
+    \endcode
+  \li
+    Open \c{ogl-runtime.pro} in Qt Creator. \c{ogl-runtime.pro} is located in the root of the
+    cloned repository.
+
+    \image ogl-runtime-pro.png
+  \li
+    Select the desired prebuilt Embedded Linux component and select \uicontrol{Configure Project}.
+
+    \image embedded-linux.png
+  \li
+    Add a build step with argument \c{install}.
+
+    \image embedded-linux-2.png
+  \li
+    From the menu, select \uicontrol{Build > Build Project "opengl-runtime"}.
+\endlist
+
+\section1 Deploy the \RUNTIME
+
+Follow the
+\l{https://doc.qt.io/QtForDeviceCreation/b2qt-installation-guides.html}{Installation guide}
+for your specific target device.
+
+*/
diff --git a/src/api/studio3d/doc/src/building-integrity.qdoc b/src/api/studio3d/doc/src/building-integrity.qdoc
new file mode 100644
index 0000000..fb09a10
--- /dev/null
+++ b/src/api/studio3d/doc/src/building-integrity.qdoc
@@ -0,0 +1,71 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+
+\title Building \RUNTIME for GHS Integrity
+\page building-opengl-runtime-integrity.html
+
+Before you build the \RUNTIME for Integrity, you will need to build
+\l{https://doc.qt.io/qt-5/integrity.html}{Qt for Integrity}.
+Then, follow the steps below:
+
+\list 1
+  \li
+    Clone the OpenGL Runtime repository from
+    \l {https://code.qt.io/cgit/qt3dstudio/ogl-runtime.git/}. You can clone the repo with the git
+    clone command:
+
+    \badcode
+    git clone git://code.qt.io/qt3dstudio/ogl-runtime.git
+    \endcode
+
+    \note If you want to use the HTTPS protocol, you can clone the \RUNTIME repo with the
+    following command:
+    \badcode
+    git clone https://code.qt.io/qt3dstudio/ogl-runtime.git
+    \endcode
+  \li
+    Run the following \c{git submodule} command:
+    \badcode
+    git submodule update --init --recursive
+    \endcode
+  \li
+    In the root folder of the cloned repo, run the \c qmake command:
+    \badcode
+    qmake
+    \endcode
+  \li
+    Next, run the \c make command:
+    \badcode
+    make
+    \endcode
+\endlist
+
+For deployment, see the \l {https://doc.qt.io/qt-5/integrity.html}{Qt for Integrity} documentation.
+
+*/
diff --git a/src/api/studio3d/doc/src/building-opengl-runtime.qdoc b/src/api/studio3d/doc/src/building-opengl-runtime.qdoc
new file mode 100644
index 0000000..b9d95b5
--- /dev/null
+++ b/src/api/studio3d/doc/src/building-opengl-runtime.qdoc
@@ -0,0 +1,44 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+
+\title Building the \RUNTIME
+\page building-opengl-runtime.html
+
+\section1 Build Instructions
+
+\list
+  \li
+    \l {Building \RUNTIME for Embedded Linux}
+  \li
+    \l {Building \RUNTIME for GHS Integrity}
+  \li
+    \l {Building \RUNTIME for QNX}
+\endlist
+
+*/
diff --git a/src/api/studio3d/doc/src/building-qnx.qdoc b/src/api/studio3d/doc/src/building-qnx.qdoc
new file mode 100644
index 0000000..fba04ce
--- /dev/null
+++ b/src/api/studio3d/doc/src/building-qnx.qdoc
@@ -0,0 +1,162 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+
+\title Building \RUNTIME for QNX
+\page building-opengl-runtime-qnx.html
+
+Before you build the \RUNTIME for QNX, you will need to install Qt for QNX and Qt 3D Studio.
+
+\section1 Install Qt for QNX
+
+\list 1
+  \li
+    Download and install QNX SDP 7.0 from the \l {http://www.qnx.com}{QNX software center}.
+  \li
+    Run the Qt online installer. You can get it from \l {https://www.qt.io/download}.
+  \li
+    Select the desired prebuilt QNX component, select \uicontrol Next.
+
+    \image qt-installer-qnx-prebuild.png
+  \li
+    Select the folder where your QNX SDP is installed.
+
+    \image qnx-sdp-folder.png
+  \li
+    Press \uicontrol Next, then press \uicontrol Install. The Qt Creator will now run.
+\endlist
+
+\section1 Build Qt 3D Studio
+
+\list 1
+  \li
+    Clone the Qt 3D Studio repository from \l {https://code.qt.io/qt3dstudio/qt3dstudio.git}.
+    You can clone the repo with the \c {git clone} command:
+
+    \badcode
+    git clone git://code.qt.io/qt3dstudio/qt3dstudio.git
+    \endcode
+
+    \note If you want to use the HTTPS protocol, you can clone the Qt 3D Studio with the following
+    command:
+
+    \badcode
+    git clone https://code.qt.io/qt3dstudio/qt3dstudio.
+    \endcode
+  \li
+    Run the following \c{git submodule} command:
+    \badcode
+    git submodule update --init --recursive
+    \endcode
+  \li
+    Open \c {qt3dstudio.pro} in the Qt Creator. \c {qt3dstudio.pro} is located in the root of the
+    cloned repository.
+
+    \image qt3dstudio-pro.png
+  \li
+    Select desired prebuilt QNX Component.
+
+    \image select-prebuilt-qnx-component.png
+  \li
+    Press \uicontrol{Configure Project}.
+  \li
+    Select the \uicontrol Project tab and \uicontrol{Build Settings}.
+  \li
+    Add a build step with the argument \c install.
+
+    \image add-build-step.png
+  \li
+    From the menu, select \uicontrol{Build > Build Project "qt3dstudio"}.
+\endlist
+
+\section1 Build the \RUNTIME
+
+\list 1
+  \li
+    Clone the \RUNTIME repository from
+    \l{https://code.qt.io/cgit/qt3dstudio/ogl-runtime.git}.
+    You can clone the repo with the \c {git clone} command:
+    \badcode
+    git clone git://code.qt.io/qt3dstudio/ogl-runtime.git
+    \endcode
+
+    \note If you want to use the HTTPS protocol, you can clone the \RUNTIME repo with
+    the following command:
+
+    \badcode
+    git clone https://code.qt.io/qt3dstudio/ogl-runtime.git
+    \endcode
+  \li
+    Run the following \ {git submodule} command:
+
+    \badcode
+    git submodule update --init --recursive
+    \endcode
+  \li
+    Open \c {ogl-runtime.pro} in Qt Creator. \c {ogl-runtime.pro} is located in the root of the
+    cloned repository.
+
+    \image ogl-runtime-pro.png
+  \li
+    Select the desired prebuilt QNX component and select \uicontrol{Configure Project}.
+
+    \image qnx-prebuild.png
+  \li
+    Add a build step with argument \c install.
+
+    \image add-build-step-qnx.png
+  \li
+    From the menu, select \uicontrol{Build > Build Project "opengl-runtime"}.
+  \li
+    The \RUNTIME is installed to the same folder where you have installed the QNX prebuilt
+    components. For example \c{~/Qt5.12/5.12.3/qnx7_x86_64/}.
+\endlist
+
+\section1 Deploy the \RUNTIME
+
+To deploy to the target device, follow the steps below:
+
+\list 1
+  \li
+    In Qt Creator, select \uicontrol{Tools > Options} from the menu.
+  \li
+    Select the \uicontrol Devices tab.
+
+    \image devices-tab.png
+  \li
+    Select \uicontrol Add.
+  \li
+    Select QNX Device, then press \uicontrol {Start Wizard}.
+
+    \image add-qnx-device.png
+  \li
+    Select \uicontrol {Deploy Qt Libraries}. This will also deploy Qt and Qt 3D Studio binaries
+    and libraries.
+\endlist
+
+*/
diff --git a/src/api/studio3d/doc/src/images/add-build-step-qnx.png b/src/api/studio3d/doc/src/images/add-build-step-qnx.png
new file mode 100644
index 0000000..8406b39
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/add-build-step-qnx.png
diff --git a/src/api/studio3d/doc/src/images/add-build-step.png b/src/api/studio3d/doc/src/images/add-build-step.png
new file mode 100644
index 0000000..d047bb7
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/add-build-step.png
diff --git a/src/api/studio3d/doc/src/images/add-qnx-device.png b/src/api/studio3d/doc/src/images/add-qnx-device.png
new file mode 100644
index 0000000..c1f5aca
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/add-qnx-device.png
diff --git a/src/api/studio3d/doc/src/images/devices-tab.png b/src/api/studio3d/doc/src/images/devices-tab.png
new file mode 100644
index 0000000..10f2884
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/devices-tab.png
diff --git a/src/api/studio3d/doc/src/images/embedded-linux-2.png b/src/api/studio3d/doc/src/images/embedded-linux-2.png
new file mode 100644
index 0000000..d46da08
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/embedded-linux-2.png
diff --git a/src/api/studio3d/doc/src/images/embedded-linux.png b/src/api/studio3d/doc/src/images/embedded-linux.png
new file mode 100644
index 0000000..b8e0efb
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/embedded-linux.png
diff --git a/src/api/studio3d/doc/src/images/ogl-runtime-pro.png b/src/api/studio3d/doc/src/images/ogl-runtime-pro.png
new file mode 100644
index 0000000..d49dbdf
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/ogl-runtime-pro.png
diff --git a/src/api/studio3d/doc/src/images/qnx-prebuild.png b/src/api/studio3d/doc/src/images/qnx-prebuild.png
new file mode 100644
index 0000000..09ce65d
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/qnx-prebuild.png
diff --git a/src/api/studio3d/doc/src/images/qnx-sdp-folder.png b/src/api/studio3d/doc/src/images/qnx-sdp-folder.png
new file mode 100644
index 0000000..269374a
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/qnx-sdp-folder.png
diff --git a/src/api/studio3d/doc/src/images/qt-installer-qnx-prebuild.png b/src/api/studio3d/doc/src/images/qt-installer-qnx-prebuild.png
new file mode 100644
index 0000000..8dc7389
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/qt-installer-qnx-prebuild.png
diff --git a/src/api/studio3d/doc/src/images/qt3dstudio-pro.png b/src/api/studio3d/doc/src/images/qt3dstudio-pro.png
new file mode 100644
index 0000000..8d8a5d5
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/qt3dstudio-pro.png
diff --git a/src/api/studio3d/doc/src/images/select-prebuilt-qnx-component.png b/src/api/studio3d/doc/src/images/select-prebuilt-qnx-component.png
new file mode 100644
index 0000000..4ef68fe
--- /dev/null
+++ b/src/api/studio3d/doc/src/images/select-prebuilt-qnx-component.png
diff --git a/src/api/studio3d/doc/src/index.qdoc b/src/api/studio3d/doc/src/index.qdoc
index aa6ab2e..1888a87 100644
--- a/src/api/studio3d/doc/src/index.qdoc
+++ b/src/api/studio3d/doc/src/index.qdoc
@@ -34,6 +34,7 @@
 \list
     \li \l {Getting Started}
     \li \l {System and Application Requirements}
+    \li \l {Building the \RUNTIME}
     \li \l {\RUNTIME C++ Classes}
     \li \l {\RUNTIME QML Types}
     \li \l {Attribute Names}{Scene Object Attribute List}