Get Involved/development/Windows: Difference between revisions

Latest revision as of 18:21, 14 October 2024

KDE Craft is a tool to build the sources and its third-party requirements. It is the easy way to build software.

A screen recording version is available https://www.youtube.com/watch?v=tpdg3grSCDg https://www.youtube.com/watch?v=aOw3KZ0pv_k

System requirements

The versions of Microsoft Windows operating system (OS) that are still supported by Microsoft include Windows Server greater than or equal to 2016 and Windows greater than or equal to 10. See https://endoflife.date/windows

Setting up craft

Installing python

While Craft is capable of installing an embedded Python version sufficient for most packages, we recommend a full installation of Python. The recommended Python versions are 3.12 or 3.11 from https://www.python.org .

Setting up PowerShell

PowerShell version 5.0 or newer is required. The versions of the Windows operating system mentioned in the system requirements chapter above have a new enough version of PowerShell.

You can check the version of PowerShell by running in PowerShell the command line:

$PSVersionTable.PSVersion

Setting up a compiler

Currently, Craft supports both the MinGW and Microsoft Visual Studio (msvc) compiler. While MinGW can be installed by Craft, Visual Studio must be installed independently by the user.

Please note that in case you or the package you are a trying to build needs QtWebEngine, you'll have to use Visual Studio(!). MinGW is not supported.

If you want to use Microsoft Visual Studio, KDE Craft Qt5 uses Visual Studio 2019, KDE Craft Qt6 uses Visual Studio 2022.

E.g. Microsoft Visual Studio Community 2019. Possible download links https://learn.microsoft.com/en-us/visualstudio/releases/2019/history

E.g. Microsoft Visual Studio Community 2022. Possible download links https://visualstudio.microsoft.com/vs/community/

Make sure the following components are selected at the minimum:

Desktop Development with C++
C++ ATL
Windows SDK

Enable development mode

Windows 10 supports the creation of symbolic links, but only if the development mode is activated. Allowing symbolic links allows faster (much faster) extraction of archives. Enable development mode

Installing Craft

Start a PowerShell environment (Do not use PowerShell ISE, it doesn't work very well with python). It might be required to run it as administrator.
Allow execution of powershell scripts by executing the following command:
```
Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
```
Select the option "[A] Yes to All".
If you have installed Python for Windows, you will probably have HTTPS certificate errors.
```
python.exe -m pip install --upgrade certifi
```
If "python.exe" is not found (see the PATH environment variable), you can try with "py.exe" instead. I.e.:
```
py.exe -m pip install --upgrade certifi
```
Install Craft and follow the instructions by executing the following command:
```
iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
```
By default KDE Craft will use two directories:

C:\CraftRoot\ This is the KDE Craft root directory.

C:\_\ Note: the name of this directory is the character underscore.
Performance. Configure your antivirus to exclude the entire Craft root directory (C:\CraftRoot\). Otherwise some packages can fail to build (e.g. build of kde/frameworks/tier2/kdoctools when AVG is used). E.g. if this a Windows 10 (or 11) Pro virtual machine and you want maximum performance you can open "Edit group policy" > Local Computer Policy > Computer Configuration > Administrative Templates > Windows Components > Microsoft Defender Antivirus > Turn off Microsoft Defender Antivirus > Enabled. You can also disable automatic Windows updates, open "Edit group policy" > Local Computer Policy > Computer Configuration > Administrative Templates > Windows Components > Windows Update > Manage end user experience > Configure Automatic Updates > Disabled. Open "Windows Defender Firewall with Advanced Security" and turn off all 3 firewall profiles.

Using Craft

To use Craft you need to start a powershell window, point that to KDEROOT\craft and run the initialization script.

C:\CraftRoot\craft\craftenv.ps1

This tells Craft about your environment settings (e.g. paths). It will load your configuration from CraftRoot\etc\CraftSettings.ini. If there are any error messages Craft will not work as expected. The output should look similar to this one (of course with your paths):

Craft               : C:\CraftRoot
Version             : master
ABI                 : windows-cl-msvc2019-x86_64
Download directory  : C:\CraftRoot\download

Then start crafting

Troubleshooting

If craft seems stalled for prolonged period of time, you may want need hit Enter in the Powershell terminal to give it a nudge.

Download Windows

You can download Microsoft Windows 11 from https://www.microsoft.com/software-download/windows11

E.g. Download the .ISO file. Then install it in a virtual machine. One way to do this is via "Virtual Machine Manager"/qemu/kvm. It will require TPM, you can either use swtpm or disable the requirement entirely by changing registry values in the installer. A screen recording version is available https://www.youtube.com/watch?v=KHK_z_vVCjQ

Virtual Machines

If you don't have windows - not to worry! Grab one of Microsoft's VM for development.

Get a VM
- Windows VM https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/
  - This VM comes with Visual Studio 2022 pre-installed as well as a whole bunch of other crap you may or may not need. You need to install VS 2019 and install modules needed to build KDE software. @sitter suggests this
Import into VM software + install guest addons if necessary and applicable
In windows search the start menu for 'Visual Studio Installer' and start it
Install VS 2019 and select the components mentioned on the Craft page. For particularly easy access you can simply pick the 'desktop development with c++' and 'linux development with c++' workloads instead of the individual components. The "Visual Studio Installer" (on the start menu) is installed as part of VS 2022 and can also manage the install of VS2019.
Setup Craft as described above

Advanced

Setup Visual Studio 2022 with Chocolatey

choco install -y visualstudio2022buildtools --package-parameters "--add  Microsoft.VisualStudio.Component.VC.ATL"

choco install -y visualstudio2022-workload-vctools visualstudio2022-workload-nativedesktop visualstudio2022-workload-manageddesktopbuildtools

Setup Visual Studio 2019 with Chocolatey

choco install -y visualstudio2019buildtools --package-parameters "--add  Microsoft.VisualStudio.Component.VC.ATL"

choco install -y visualstudio2019-workload-vctools visualstudio2019-workload-nativedesktop visualstudio2019-workload-manageddesktopbuildtools

```
choco install -y windows-sdk-10
```

@@ Line 1: / Line 1: @@
-''Craft'' is a tool to build the sources and its third-party requirements. It is the '''easy''' way to build software.
+KDE Craft is a tool to build the sources and its third-party requirements. It is the '''easy''' way to build software.
-A screen recording version is available https://www.youtube.com/watch?v=aOw3KZ0pv_k https://www.youtube.com/watch?v=Y7D7dkYWSWU
+A screen recording version is available https://www.youtube.com/watch?v=tpdg3grSCDg https://www.youtube.com/watch?v=aOw3KZ0pv_k
 == System requirements ==
@@ Line 9: / Line 9: @@
 == Setting up craft ==
 === Installing python ===
-While Craft is capable of installing an embedded Python version sufficient for most packages, we recommend a full installation of Python. Python is currently releasing new versions in the Python 3 series. [https://www.python.org/downloads/ Download Python 3.x]
+While Craft is capable of installing an embedded Python version sufficient for most packages, we recommend a full installation of Python. The recommended Python versions are 3.12 or 3.11 from https://www.python.org .
-=== Setting up a powershell ===
+=== Setting up PowerShell ===
-PowerShell is required to be at least version 5.0.
+PowerShell version 5.0 or newer is required.
-If you're running Windows 10 you most probably won't need to update Powershell.
+The versions of the Windows operating system mentioned in the system requirements chapter above have a new enough version of PowerShell.
-You can check the version by invocating <code>$PSVersionTable.PSVersion</code> in a PowerShell terminal.
+You can check the version of PowerShell by running in PowerShell the command line:
+<pre>$PSVersionTable.PSVersion</pre>
-In case you need a newer one, we recommend
-[https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-windows?view=powershell-6 PowerShell Core].
-The latest version of the standard powershell can be found [https://www.microsoft.com/en-us/download/details.aspx?id=50395 here].
 === Setting up a compiler ===
@@ Line 28: / Line 24: @@
 ''Please note that in case you or the package you are a trying to build needs QtWebEngine, you'll have to use Visual Studio(!). MinGW is [https://bugreports.qt.io/browse/QTBUG-42725 not supported].''
-For Visual Studio, currently, only version 2019 is supported. E.g. Microsoft Visual Studio Community 2019. Possible download links https://learn.microsoft.com/en-us/visualstudio/releases/2019/history
+If you want to use Microsoft Visual Studio, KDE Craft Qt5 uses Visual Studio 2019, KDE Craft Qt6 uses Visual Studio 2022.
+E.g. Microsoft Visual Studio Community 2019. Possible download links https://learn.microsoft.com/en-us/visualstudio/releases/2019/history
+E.g. Microsoft Visual Studio Community 2022. Possible download links https://visualstudio.microsoft.com/vs/community/
 Make sure the following [https://docs.microsoft.com/en-us/visualstudio/install/modify-visual-studio components] are selected at the minimum:
@@ Line 44: / Line 44: @@
 # Allow execution of powershell scripts by executing the following command:
 #:<pre>Set-ExecutionPolicy -Scope CurrentUser RemoteSigned</pre>
+#: Select the option "[A] Yes to All".
+# If you have installed Python for Windows, you will probably have HTTPS certificate errors.
+#: <pre>python.exe -m pip install --upgrade certifi</pre>
+#: If "python.exe" is not found (see the <code>PATH</code> environment variable), you can try with "py.exe" instead. I.e.:
+#: <pre>py.exe -m pip install --upgrade certifi</pre>
 # Install Craft and follow the instructions by executing the following command:
 #: <pre>iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))</pre>
-# Performance. Configure your antivirus to exclude the entire craft root directory (<code>C:\CraftRoot\</code>). Otherwise build of some packages can fail (e.g. build of <code>kde/frameworks/tier2/kdoctools</code> when AVG is used). E.g. if this a Windows 10 Pro virtual machine and you want maximum performance you can open "Edit group policy", then you can turn off "Microsoft Defender Antivirus" and disable "Windows Update > Configure Automatic Updates"; open "Windows Defender Firewall with Advanced Security" and turn off all 3 firewall profiles.
+#: By default KDE Craft will use two directories:
+#:<code>C:\CraftRoot\</code> This is the KDE Craft root directory.
+#:<code>C:\_\</code> Note: the name of this directory is the character underscore.
+# Performance. Configure your antivirus to exclude the entire Craft root directory (<code>C:\CraftRoot\</code>). Otherwise some packages can fail to build (e.g. build of <code>kde/frameworks/tier2/kdoctools</code> when AVG is used). E.g. if this a Windows 10 (or 11) Pro virtual machine and you want maximum performance you can open "Edit group policy" > Local Computer Policy > Computer Configuration > Administrative Templates > Windows Components > Microsoft Defender Antivirus > Turn off Microsoft Defender Antivirus > Enabled. You can also disable automatic Windows updates, open "Edit group policy" > Local Computer Policy > Computer Configuration > Administrative Templates > Windows Components > Windows Update > Manage end user experience > Configure Automatic Updates > Disabled. Open "Windows Defender Firewall with Advanced Security" and turn off all 3 firewall profiles.
 == Using Craft ==
@@ Line 89: / Line 97: @@
 == Advanced ==
+=== Setup Visual Studio 2022 with [https://chocolatey.org/ Chocolatey] ===
+* <pre>choco install -y visualstudio2022buildtools --package-parameters "--add  Microsoft.VisualStudio.Component.VC.ATL"</pre>
+* <pre>choco install -y visualstudio2022-workload-vctools visualstudio2022-workload-nativedesktop visualstudio2022-workload-manageddesktopbuildtools</pre>
 === Setup Visual Studio 2019 with [https://chocolatey.org/ Chocolatey] ===
 * <pre>choco install -y visualstudio2019buildtools --package-parameters "--add  Microsoft.VisualStudio.Component.VC.ATL"</pre>
 * <pre>choco install -y visualstudio2019-workload-vctools visualstudio2019-workload-nativedesktop visualstudio2019-workload-manageddesktopbuildtools</pre>
 * <pre>choco install -y windows-sdk-10</pre>