mirror of
https://gitlab.com/kelteseth/ScreenPlay.git
synced 2024-09-15 06:52:34 +02:00
122 lines
4.6 KiB
Markdown
122 lines
4.6 KiB
Markdown
# Developer Setup
|
|
1. Install latest [git + git-lfs](https://git-scm.com/)
|
|
2. Install [python 3](https://www.python.org/)
|
|
3. Clone ScreenPlay
|
|
``` bash
|
|
git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay
|
|
```
|
|
4. Download the latest __Qt 5.15.x__ for you platform. Earlier versions are not supported!
|
|
1. [Install instructions Windows](#windows)
|
|
1. [Install instructions Linux](#linux)
|
|
1. [Install instructions MacOSX](#macosx)
|
|
5. Start the following script to download all needed dependencies automatically. This will create a ScreenPlay-vcpkg folder in the same directory as your ScreenPlay source folder.
|
|
``` bash
|
|
cd Tools
|
|
py setup.py
|
|
```
|
|
* This will install these dependencies via __vcpkg__
|
|
* openSSL 1.1.1d
|
|
* sentry-native
|
|
* doctest
|
|
* benchmark
|
|
* infoware
|
|
|
|
<div>
|
|
<img width="100%" height="auto" src="../.gitlab/media/QtCreator_kit.png">
|
|
</div>
|
|
|
|
5. Open __QtCreator__ and open the settings `Tools -> Options`
|
|
6. Clone an existing kit like `Qt 6.2.0 MSVC2019 64bit` and add `ScreenPlay` to the new kit name
|
|
5. Edit CMake variables amd add CMAKE_TOOLCHAIN_FILE and VCPKG_TARGET_TRIPLET
|
|
* `Kits -> <Your_Kit> -> CMake Configuration`
|
|
|
|
Append this:
|
|
``` bash
|
|
CMAKE_TOOLCHAIN_FILE:STRING=%{CurrentProject:Path}/../ScreenPlay-vcpkg/vcpkg/scripts/buildsystems/vcpkg.cmake
|
|
# Only _one_ of these lines that match your OS:
|
|
VCPKG_TARGET_TRIPLET:STRING=x64-windows
|
|
VCPKG_TARGET_TRIPLET:STRING=x64-linux
|
|
VCPKG_TARGET_TRIPLET:STRING=x64-osx
|
|
```
|
|
|
|
|
|
6. Save and close the settings.
|
|
7. Open Project via `File -> Open File or Project` and select your `CMakeLists.txt`. Then select __our created kit__, press `Configure Project`
|
|
<div>
|
|
<img height="auto" src="../.gitlab/media/QtCreator_kit_select.png">
|
|
</div>
|
|
8. Press build (the big green play button on the bottom left). This will compile and start ScreenPlay and copy all necessary files into your Qt installation.
|
|
|
|
## Windows
|
|
1. It is recommended (but not necessary) to use an easy git UI like [gitextensions](https://gitextensions.github.io/).
|
|
1. [Download and install the most recent MSVC 2019 Community](https://visualstudio.microsoft.com/vs/community/)
|
|
- Select "Desktop development with C++"
|
|
1. [Download and install Qt 5 binary installer from qt.io](https://www.qt.io/download-qt-installer)
|
|
- Install the Maintaince tool
|
|
- Select the following features to install:
|
|
- Qt 6.2.0
|
|
- MSVC 2019 64-bit
|
|
- ALL Additional Libraries
|
|
- Qt Quick 3d
|
|
- Qt 5 Compatibility Module
|
|
- Qt Shader Tools
|
|
- Developer and Designer Tools
|
|
- Cmake
|
|
- Ninja
|
|
|
|
## Linux
|
|
1. Install dependencies for your distro:
|
|
``` bash
|
|
# Debian/Ubuntu
|
|
sudo apt install build-essential libgl1-mesa-dev lld ninja-build cmake
|
|
|
|
# Fedora/RHEL/CentOS (yum)
|
|
sudo yum groupinstall "C Development Tools and Libraries"
|
|
sudo yum install mesa-libGL-devel
|
|
|
|
# openSUSE (zypper)
|
|
sudo zypper install -t pattern devel_basis
|
|
```
|
|
1. [Download and install Qt 5 binary installer from qt.io](https://www.qt.io/download-qt-installer)
|
|
- Install the Maintaince tool
|
|
- Select the following features to install:
|
|
- Qt 6.2.0
|
|
- GCC
|
|
- ALL Additional Libraries
|
|
- Qt Quick 3d
|
|
- Qt 5 Compatibility Module
|
|
- Qt Shader Tools
|
|
- Developer and Designer Tools
|
|
- OpenSSL 1.1.1.c Toolkit
|
|
- OpenSSL 64-bit binaries
|
|
- Cmake
|
|
- Ninja
|
|
## MacOSX
|
|
1. [Download and install Qt 5 binary installer from qt.io](https://www.qt.io/download-qt-installer)
|
|
- Install the Maintaince tool
|
|
- Select the following features to install:
|
|
- Qt 6.2.0
|
|
- Qt WebEngine
|
|
- ALL Additional Libraries
|
|
- Qt Quick 3d
|
|
- Qt 5 Compatibility Module
|
|
- Qt Shader Tools
|
|
- Developer and Designer Tools
|
|
- OpenSSL 1.1.1.c Toolkit
|
|
- OpenSSL 64-bit binaries
|
|
- Cmake
|
|
- Ninja
|
|
2. Install [homebrew](https://brew.sh/)
|
|
- Open a terminal and install clang -> brew install llvm cmake ninja
|
|
3. Change your default kit: QtCreator -> Options -> Kits -> Select your default kit (Desktop Qt 5.13.0) -> Change c and c++ Compiler to Apple Clang (x86_64)
|
|
|
|
|
|
# Developer docs
|
|
We use qdoc to generate documentation. Qt6 is the minimum version qdoc, because of vastly improved c++ parsing support.
|
|
* qdoc.exe configWindows.qdocconf
|
|
If you have installed Qt in a different directory, change the path to your Qt location.
|
|
|
|
Some useful links:
|
|
* [Introduction to QDoc](https://doc.qt.io/qt-5/01-qdoc-manual.html)
|
|
* [Writing qdoc comments](https://doc.qt.io/qt-5/qdoc-guide-writing.html)
|