mirror of
https://gitlab.com/kelteseth/ScreenPlay.git
synced 2024-09-03 00:59:47 +02:00
Add VSCode setup to docs
This commit is contained in:
parent
31005092be
commit
d53dd498bb
@ -14,7 +14,7 @@
|
|||||||
2. Python 3.11+ and select `Add to Path` during the installation. [Download](https://www.python.org/downloads/)
|
2. Python 3.11+ and select `Add to Path` during the installation. [Download](https://www.python.org/downloads/)
|
||||||
3. Optional if you do not have tools like `git` or `cmake` installed, we recommend `Chocolatey`:
|
3. Optional if you do not have tools like `git` or `cmake` installed, we recommend `Chocolatey`:
|
||||||
1. Chocolatey via Powershell (Administrator) [Download](https://chocolatey.org/install)
|
1. Chocolatey via Powershell (Administrator) [Download](https://chocolatey.org/install)
|
||||||
2. Run `choco.exe install git cmake -y`
|
2. Run `choco.exe install git vscode cmake --installargs 'ADD_CMAKE_TO_PATH=System' -y`
|
||||||
|
|
||||||
## Linux
|
## Linux
|
||||||
1. Install dependencies for Debian/Ubuntu:
|
1. Install dependencies for Debian/Ubuntu:
|
||||||
@ -29,29 +29,40 @@ sudo apt-get install libx11-dev xserver-xorg-dev xorg-dev
|
|||||||
1. Install [brew](https://brew.sh) that is needed by some third party vcpkg packages. Do not forget to add brew to your path as outlined at the on of the installation!
|
1. Install [brew](https://brew.sh) that is needed by some third party vcpkg packages. Do not forget to add brew to your path as outlined at the on of the installation!
|
||||||
- `brew install pkg-config git llvm cmake`
|
- `brew install pkg-config git llvm cmake`
|
||||||
|
|
||||||
# Setup QtCreator and compile ScreenPlay
|
# Download ScreenPlay and dependencies
|
||||||
1. Clone ScreenPlay
|
|
||||||
``` bash
|
``` bash
|
||||||
git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay/ScreenPlay
|
git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay/ScreenPlay
|
||||||
|
cd ScreenPlay
|
||||||
```
|
```
|
||||||
1. Start the following script to download _all_ needed dependencies automatically.
|
Downloading dependencies is 100% automated. Simply run the `setup.py` script
|
||||||
``` bash
|
``` bash
|
||||||
cd Tools
|
cd Tools
|
||||||
# Windows defaults to python, linux and macOS uses python3
|
# Windows defaults to python, linux and macOS uses python3
|
||||||
python -m pip install -r requirements.txt
|
python -m pip install -r requirements.txt
|
||||||
|
# This scrit will:
|
||||||
|
# 1. Downloads `Qt` and `QtCreator`
|
||||||
|
# 2. Create a `vcpkg` folder for dependencies
|
||||||
|
# 3. Compiles the dependencies
|
||||||
|
# 4. Downloads ffmpeg
|
||||||
python setup.py
|
python setup.py
|
||||||
```
|
```
|
||||||
1. This will:
|
Now you can either use VSCode or QtCreator:
|
||||||
1. Download `Qt` and `QtCreator`
|
# Option 1: Setup VSCode and compile ScreenPlay
|
||||||
2. Create a `vcpkg` folder for dependencies
|
1. Open VSCode
|
||||||
3. Compile the dependencies
|
1. Install these extentions:
|
||||||
4. Download ffmpeg
|
1. [C/C++ for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
|
||||||
2. Open QtCreator or VSCode
|
1. [CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools)
|
||||||
|
2. Press: `CTRL` + `SHIFT` + `P` for every command:
|
||||||
|
1. `CMake: Select Configure Preset`. Select one of the listed presets like `MSVC SP Qt 6.4.2 Debug`
|
||||||
|
2. `CMake: Configure`
|
||||||
|
3. Press `F7` to Compile and `F5` to run!
|
||||||
|
# Option 2: Setup QtCreator and compile ScreenPlay
|
||||||
|
1. Open QtCreator at:
|
||||||
1. Windows: `..\aqt\Tools\QtCreator\bin\qtcreator.exe`
|
1. Windows: `..\aqt\Tools\QtCreator\bin\qtcreator.exe`
|
||||||
2. Linux: `../aqt/Tools/QtCreator/bin/qtcreator`
|
2. Linux: `../aqt/Tools/QtCreator/bin/qtcreator`
|
||||||
3. MacOS: `../aqt/Qt Creator`
|
3. MacOS: `../aqt/Qt Creator`
|
||||||
3. Select the imported temporary kit like `ScreenPlay 64bit Debug Windows MSVC 2022 Community`
|
2. Select the imported temporary kit like `MSVC SP Qt 6.4.2 Debug`
|
||||||
4. Compile!
|
3. Press `CTRL` + `B` to Compile and `F5` to run!
|
||||||
|
|
||||||
# Developer docs
|
# Developer docs
|
||||||
We use qdoc to generate documentation. Qt6 is the minimum version qdoc, because of vastly improved c++ parsing support.
|
We use qdoc to generate documentation. Qt6 is the minimum version qdoc, because of vastly improved c++ parsing support.
|
||||||
|
Loading…
Reference in New Issue
Block a user