From 5adcb6ae9f7d131120b3f00ed91fb23263f941f8 Mon Sep 17 00:00:00 2001 From: Elias Steurer Date: Fri, 26 Feb 2021 11:16:27 +0100 Subject: [PATCH] Update DeveloperSetup.md --- .gitlab/media/QtCreator_kit_select.png | Bin 0 -> 5786 bytes Docs/DeveloperSetup.md | 72 ++++++++++++++----------- 2 files changed, 42 insertions(+), 30 deletions(-) create mode 100644 .gitlab/media/QtCreator_kit_select.png diff --git a/.gitlab/media/QtCreator_kit_select.png b/.gitlab/media/QtCreator_kit_select.png new file mode 100644 index 0000000000000000000000000000000000000000..91f380e7020105eaae5d31b26595e73d75121060 GIT binary patch literal 5786 zcmbW5c|4ojy2oEtZBNzEL2X*pR$3G#hD~ZHZM8LS^BhXVtSE{`RF#&N);tv3tThuf zVrWZCOfe?JR5gnj6A_8H>E7p_d+)jD+&}Ig@320f^}g$Q*7L0OeAn-#v7s*4Nx_o< z0C3&Ad&>j>*cMsuc_)ss?q^UJt5^@V025tpptAqs3afDxcGKV{0MsOKGMqSA?Y}*| zYaIXp-0eRvwoczt7XUafckk9sv&RmkDaZ>m%3cubx0aPF{mFUhL$1j(P!C)M>*JP<@Sq?=w9s@32ItpSrDw@s)oH+6M6riPb z!WGaGKBzVX)erFYvU(MMaP)C^_e%hP*Oxj@)}GhyuKUpHI8Uhe^r!E7Ti1J}5ZQnc z>4V6(N}jkb%|phpB3lLhy>)}z;IGyVUKvDtD|3#zA)%)5gV5m|C>yYvX3?#eCd(y} zY(B~w5m>+I!#wh@4FQgrQ0&K9|Eyzd_sBi5I|&#E3$D+Z2zDb5DEyG?M*yx%G!C)8 z?Y?-yro6O@=7DQ_ z%4?G2x5NK;=jAIdX4O28`gbz|9MQhc4r~`r)lYWGDE`-!-8G*{shBBi3L@E1y^3F7 zP-)Ul0V9~rVT!{^MjDcHb93v~?rIw)x#6ohY(V$cOv=GhE}|)CakC0>&=YPM^!`R! zQ3%hX$xYkRNk;HgVA_+-&&OHcVAZMb4mc%&h;H6qr=uX9aW}&xdSOM;Z5zTarjY0% z<*dG&z=tHiLU99mR-2B@b@WDIL4l42V^arjD(yT}aJ={1Cwrkjzw_e= zZ|Nf;(30mw+8J@C(#aA!`$N5~jwwHgfA-;$!xec5gU~7m%_1F38~+xG&#Fndt?lm* zv0Yg>^DVS^Nsr$0by%;WW2@={>Df%R>`=xd-5 zCT(e9u`lcW@KV8Z*PG9*bx>%utuUPYd&vGuiM_AP^5>wqS9crV)wZRZE)Kr%k__B5 zSV&7CJd7d6qn?E}7{x*a${mxie32} z+H?0o_U~XkJ@!!$@zmTlw7=hdQAlYccCbY+6vR~bOv#%h`H+$c6hJ9p^DB4Xc54hY7bKDBB7pN zTdA&S!wksg<6IZ%-&EO#mW#fnNLzNpsZ;!obDat3_g`21v$M0e=^Jh6oD9Yd1Y;|P z_}=RNuT2x;rgU93rNw?O1{iEbjBP zd~hynkv>8AaXP7aA+eU&>z?Ab<!#5082ZEi|K`p%m<$|I_kz5C6(uHj~Nx-L4zEkqDJj##t@dimy- zZ%nR+ifx7OLOHp=+|h+0XT%C5u1YM-pN8i)-L8`-sq2}~DyJsd!^AFY+}o6OkbUuN zGEI5Ul-=T4QIFYNai-8ZQV4|dP~cCY4VfD!rqLUXw+}`JUg>f^vNomZ)`4{kd(yTA zA20e5jb%SH*#~+ymW&|BxK+K1#{({c`f}3wx-{?I?;>}rqTxOlNVa)m!U8K(P|K@u zpXcF1Q|Qng{L|t>r+p@Uqi41~##`xKc`2nt1JA@m5L3~6v3$}l*c|l++I<{0%|ial z(nNDe045e~wTH94S{B0NDwK}{aF=je4$H=^AiJWp-`-%lQWNo7u*?ND^7plvC$_;| zI1}Bk@!A(LK9NkBxRlgiFu8~{Q<(BPUkT><75PJxFo0NF2Zv2~qLQBjX z^;Ua7w`a)+#qmY{OuB*y3x2J4rlEj{^aG~Gt$$m zcUJC2I0VZUU610-#mBK`fy;r*QKWw~sy1BNTJxCsy|C5yC6gu~n#VP3c#2TswQioe zVzU4~={oL;<{!jr3Ag@~G7Ej+9q2eCe@EQ#q`yu`dsapTxOc}-Rbg35EcmEl7e#Zur$POS_DU{G}6v{3w0PJHs2+-LGNd4e}>L>)y49${;kQU8kkd zpQsr|R5pt?69OX8$sj8){yc)u#9&uuFTwP8;>6b!(%QUKu8# zps0Acjk#YIW)W}k8`IEBsC6g!LT_-rj2MOX-H~RrmSw2X=bCpk4I+xfzO9sv)rH2#!yXTP;+qnit8b#wp{TJ z!2|4ved@kDUp|5ae}d>HFx7)FZ%e~6X+i|OJ}J`t39c&|c?Ry76~QlpwKf!21%V5N zBCLuy&1i)m9#D5bRwO97)YsxV)ewYwXQ6JK==wrW+C+l!ib7NTyxN8tXZ(1nD*Dk% zVpy_Ido+rXGX_)(P0&{YRUZH&OtIi1?E^|G{CG zj0pBUuP3#2SoFpF=0l|Q;TJC855Fj@n>g*eAr_;-PzXB6z-Ojarp%(kUmb`DEn)!~ zBL4ToVtCzAe7;m+@L?Ww4VuU+?|k<$Vg#AS{&wD23Qa%Goz5rW;$BA7?S} z$AFJC&i`e=-_iIkYotTQ4wglsZJU0QfYy}z#{@n1tA`Xk*tsUzDC9B9|w+>S|1)``SGm} z0z{-AGXpie`Je9pHG0TUcGytYyQdDea}O4{BLA0ZuyxU6niRFBo5>$4I;R4?_~ z%ZVE2PLm}AW&3s7Qf^w7if^$YesPI)(y&-1o5-NlzuFM|Tb~z4>x?J))AE^KDS_5I z1&%M&e65-yXFa`b@7Tfe=C@f)Yar5Ce_PWVWbRd)Ni}cIRT)3S*IM-$9w$Asr_|dV z)S|wvscw6j(0qFQ!IDvP@l4gc^4>zdCKMj@^1%+BIj#3fEO9aiK!d1HNAJV5pr1Ff;^h8Evb1R-+hUIkR1#ZE`mg4+^V?PS>=P8356 z=|jqLUELvAPd)AMOrSzJD}6=Y$_6)7`|Ty)%EHT(^fF9M+lQQT!Gf`_)405M_A_S4 zFU$20hKXffOd3?*akNj#mws=+b@=@3IjVWFlI6_0uv_Dyj z(B@A(KJZA<%6IakCvpPs=2U6P325RH6UE9Q%yf8y+c54yj&|#N4ad^LjuiCf$ zJ_2;pSOH(yUg+7CQ*?h`cC#E&Atj@qloDuZ zna0>`=Lt!v9a^ywZES3u2=x4@NgmMg@$l1lMN~>QH+ZJ%yR5jHX?_=mAGcD88|xI^PBRJ@J+Ge8JoGaZ2{SHi(+@nSu_^J})bs8n`h|EnSm?a=ZQ;tW!vz zB0{o0S%1R`{Ys?2!X-oXo{uS2vgWpX=fg*R1Q*rXqQgOM@-WT-4f_E|BqHEK(FMdmRXk?MW<%N0*3`&Cl!m>p-0#=s5rzv4D=A(Z`Ei!b|DD+czg z-8G?km*BbG58mj|oC&9Uk2iQ{RV1d!mZ-e#i}@PIuP2+vDS#Q_??`tWf zVwmN5mue48^X!Py*U|wd&1N`Bz(pf~7R-y!a?K?Bjl$!~SJ1>(6?MX#VKQ}kO zEjL=bx>J_|bo= ztDQ&FYvPjtJ|^V$b#|?Sdr|Mb0}Mw%3e^GHLAeJOt?Fo7iCvLoX`k-qCV%6GD~*S< zY<1#wg~Tz97*aOTKbV&l1g`n+&!p{5!?!v!nb!kJZy2!M&&8Eb#Lm{<5w`Xgt_rt~ z7Yef`I~jP5$-oXYE}j`zov1FS>`vcg8Laq9+J8SP{bXn`m}*7mEA)|R#CJ{}f+2!2f&_Wu!C_7L_WGN>=F z^rSjEOgm^_)aUFi6bv4?AK46xDW8C1$ERvPTUH*@XSN|hiww##FZI|2M7ud${pP?z zz_zbFPPWa!usQVv`J5&9dKy*PW#Kej!P#DtKGJ%n#{R1VHfl2njO3+cHI%^Xn;HFN z4Uw=Ar&aHtCcNaS)>gabeWau_WvEQWJBe!pCAxmA?M9-E5R!xV{;q#G_{RE&hu$_R zo=R&Hopz%ic5Vbb$a+UlCcmz@>9=y{eU7?yZGgAs_MC7)id++ zkzv2VB=qNqoec{-Ew-4D4=omU7$OG?xFVtlW!2HQr=Lh1$}WP~7g1a!73i43M^+H* z9?y=CA5U(Xw!O?an^I-p7WS^h5&Xdfqrn%}GMeR*b#6Q!d9pQ{#d2kpn#9+e1FjH%tZIBnyt^BKta?GZ4zzB-tfM^nWoQ%jx@m)H%y>qwG6A`pe zc$Bh7Gyx(Uv+q4Yc89yFl^ScDg&)1&_RB){KI0;Y?`QHeg?AVQ4~_wU+&leK)QrmW z0!jnal3&v-%ksSb1kdaLZauJi|KGCU|8uSD%pbBDS7N(GL*RTYJsG%n+wfMUwqxXf E0CF;7N&o-= literal 0 HcmV?d00001 diff --git a/Docs/DeveloperSetup.md b/Docs/DeveloperSetup.md index 42a6d856..3313ec63 100644 --- a/Docs/DeveloperSetup.md +++ b/Docs/DeveloperSetup.md @@ -4,45 +4,52 @@ ``` bash git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay ``` -3. Download the latest [__Qt 5.15__](https://www.qt.io/download-qt-installer). Earlier versions are not supported! -4. Start install-dependencies.bat to download dependencies. ATTENTION: This will create a ScreenPlay-vcpkg folder in the same directory as your ScreenPlay source folder. +3. 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) +4. Start install-dependencies.bat to download dependencies. This will create a ScreenPlay-vcpkg folder in the same directory as your ScreenPlay source folder. ``` bash -//Windows -.\Tools\install-dependencies.bat +#Windows +cd Tools +.\install_dependencies_windows.bat -//Linux -sudo apt install git gcc cmake build-essential libgl1-mesa-dev -chmod +x install-dependencies.sh -.\Tools\install-dependencies.sh +#Linux and MacOSX +cd Tools +chmod +x install_dependencies_linux_mac.sh +.\install_dependencies_linux_mac.sh ``` * This will install these dependencies via __vcpkg__ * openSSL 1.1.1d * sentry-native - * Download these dependencies via __git submodules__ - * qt-google-analytics - * Download ffmpeg binaries -5. **Follow the steps below for your OS**. -6. Open the CMakeLists.txt via QtCreator. **This can take some time until QtCreator parses all files!** + * doctest + * Download ffmpeg binaries from https://www.gyan.dev +5. Open the CMakeLists.txt via QtCreator. **This can take some time until QtCreator parses all files!** -7. Add CMake variables +6. Add CMake variables * Add CMAKE_TOOLCHAIN_FILE and VCPKG_TARGET_TRIPLET - * Extras -> Tools -> Kits -> -> CMake Configuration -> Append this: - * CMAKE_TOOLCHAIN_FILE:STRING=%{CurrentProject:Path}/../ScreenPlay-vcpkg/vcpkg/scripts/buildsystems/vcpkg.cmake - * VCPKG_TARGET_TRIPLET:STRING=x64-windows - * or Linux: x64-linux MacOSX: x64-osx - + * `Extras -> Tools -> Kits -> -> 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 +```
-8. Check if Ninja is selected - * Extras -> Tools -> Kits -> -> CMakeGenerator -> Change to: - * Generator: Ninja - * Extra Generator: CodeBlocks -9. Save and close the settings. -10. Press build (the big green play button). This will compile the project and copy all necessary files into your Qt installation. +8. Save and close the settings. +9. Open Project via `File -> Open File or Project` and select your `CMakeLists.txt`. Then select __our created kit__, press `Configure Project` +
+ +
+9. 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 +## Windows 1. [Download and install the most recent MSVC 2019 Community](https://visualstudio.microsoft.com/vs/community/) - Select "Desktop development with C++" 2. [Download and install Qt 5 binary installer from qt.io](https://www.qt.io/download-qt-installer) @@ -55,7 +62,7 @@ chmod +x install-dependencies.sh - Cmake - Ninja -### Linux +## Linux 1. Install dependencies for your distro: ``` bash # Debian/Ubuntu @@ -71,14 +78,19 @@ sudo zypper install -t pattern devel_basis 2. [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 5.15.1 + - Qt 5.15.2 - GCC - Qt WebEngine -### OSX + - 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 5.15.1 + - Qt 5.15.2 - Qt WebEngine - Developer and Designer Tools - OpenSSL 1.1.1.c Toolkit