Mirrors/ScreenPlay
Mirrors/ScreenPlay
1
0
Fork 0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-09-01 08:09:48 +02:00
Code Issues Projects Releases Activity

Add examples to python scripts

Browse Source
This commit is contained in:
Elias Steurer 2021-09-04 12:13:19 +02:00
parent d233e10441
commit dca107efbb
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Tools/Readme.md
View File

@ -1,15 +1,27 @@
## Tools
This folder contains serveral python tools to help with development:
This folder contains serveral python tools to help with development. Depending on your os you have to change the python command to ```python```, ```python3``` or ```python3.9```
#### setup.py
- Installs third party dependencies for all platforms
- Installs third party c++ dependencies for all platforms
- ```python3 setup.py -u=xxx -p=xxx```
#### build.py
- Build ScreenPlay locally
- ```python3 build.py -t=release```
#### clang_format.py
- Invokers clang-format for all .cpp and .h files
#### qdoc.py
- Builds documentation for all projects into Docs/html
#### download_ffmpeg.py
- Donwload ffmpeg for macos only for now
- ```python3 clang_format.py ```
#### qml_format.py
- Calls qmlformat for all qml files
- ```python3 qml_format.py```
#### qdoc.py
- Builds documentation for all projects into Docs/html
- ```python3 qdoc.py```
#### download_ffmpeg.py
- Donwload ffmpeg for macos only for now
- ```python3 download_ffmpeg.py```
#### steam_publish.py
- Upload to steam. This is needed to add some much needed output like git commit to the steam ui for selecting branches
- ```python3 steam_publish.py -u xxx -p xxx```