Guidelines and HOWTOs/Build from source/Windows: Difference between revisions

Revision as of 08:59, 1 April 2019

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

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 current version is 3.7. Download Python 3.6+

Setting up a powershell

Powershell is required to be at least version 5.0. If you're running Windows 10 you most probably won't need to update Powershell.

You can check the version by invocating $PSVersionTable.PSVersion in a Powershell terminal.

In case you need a newer one, we recommend Powershell Core.

The latest version of the standard powershell can be found here.

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.

Direct X SDK (only for MinGW setups)

If you are using the MinGW compiler, in order to compile the Qt5 qtbase package you will also need to install the Microsoft DirectX SDK. Make sure to open a new command line window after the installation for the environment variables to be set.

(Optional) 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. It might be required to run it as administrator.
Allow execution of powershell scripts by executing the following command:
```
Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
```

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'))

Consider adding exception for the entire craft root directory to your antivirus' exceptions, otherwise build of some packages can fail (example: build of frameworks/tier2/kdoctools when AVG is used).

Note: For Microsoft Visual Studio compiler, it's necessary to have VCTOOLSREDISTDIR environment variable pointing to: "C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\VC\Redist\MSVC\xx.xx.xxxxx" for MSVS 2017 and VCINSTALLDIR environment pointing to "C:\Program Files (x86)\Microsoft Visual Studio\2015\Community\VC\" for MSVS 2015.

Using the stock Qt SDK

This will skip all Qt packages and use the official Qt builds instead. It will work fine for most CMake based recipes but definitely cause problems with QMake based projects. You will of course also miss all patches we usually apply to Qt. This is only recommended when you know what you are doing and you won't get support for in our channel.

To activate the SDK mode adapt the [QtSDK] section in your etc/kdesettings.ini to something like:

   [QtSDK]
   ## Whether to use prebuild Qt binaries.
   Enabled = True
   ## The path to the Qt sdk.
   Path = C:\Qt
   ## The version of Qt.
   Version = 5.9
   ## The compiler version, if you are not sure what to use, have a look at the directory set in QtSDK/Path.
   ## The compiler must be of the same type as General/KDECOMPILER.
   ## If you are using mingw please make sure you have installed the mingw using the Qt installer.
   Compiler = msvc2017_64

Using Craft

To use Craft you need to start a Powershell window, point that to KDEROOT\craft and run the initalization script. For example:

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):

PS C:\CraftRoot\craft>.\craftenv.ps1
Craft               : C:\CraftRoot
Version             : master
ABI                 : windows-msvc2017_64-cl
Download directory  : C:\CraftRoot\download

Then start crafting

@@ Line 1: / Line 1: @@
-''emerge'' is a tool to build the KDE sources and its third-party requirements on MS Windows. It is the '''easy''' way to build KDE on MS Windows.
+''Craft'' is a tool to build the sources and its third-party requirements. It is the '''easy''' way to build software.
+== 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 current version is 3.7. [https://www.python.org/downloads/ Download Python 3.6+]
+=== Setting up a powershell ===
+Powershell is required to be at least version 5.0.
+If you're running Windows 10 you most probably won't need to update Powershell.
+You can check the version by invocating <tt>$PSVersionTable.PSVersion</tt> in a Powershell terminal.
+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 emerge ==
 === Setting up a compiler ===
-Currently emerge supports both the MinGW and Microsoft Visual Studio (msvc) compiler.
+Currently, Craft supports both the MinGW and Microsoft Visual Studio (msvc) compiler.
-While MinGW is can be installed by emerge, [https://www.visualstudio.com/ Visual Studio] must be installed independently by the user.
+While MinGW can be installed by Craft, [https://www.visualstudio.com/ Visual Studio] must be installed independently by the user.
+=== Direct X SDK (only for MinGW setups) ===
+If you are using the MinGW compiler, in order to compile the Qt5 ''qtbase'' package you will also need to install the [https://www.microsoft.com/en-us/download/details.aspx?id=6812 Microsoft DirectX SDK]. Make sure to open a new command line window after the installation for the environment variables to be set.
+=== (Optional) 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.
+[https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development Enable development mode]
+=== Installing Craft===
+# [https://docs.microsoft.com/en-us/powershell/scripting/setup/starting-windows-powershell?view=powershell-6 Start a PowerShell environment]. It might be required to run it [https://docs.microsoft.com/en-us/powershell/scripting/setup/starting-windows-powershell?view=powershell-6#with-administrative-privileges-run-as-administrator as administrator].
+# Allow execution of powershell scripts by executing the following command:
+#:<pre>Set-ExecutionPolicy -Scope CurrentUser RemoteSigned</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>
+# Consider adding exception for the entire craft root directory to your antivirus' exceptions, otherwise build of some packages can fail (example: build of <code>frameworks/tier2/kdoctools</code> when AVG is used).
+Note: For Microsoft Visual Studio compiler, it's necessary to have VCTOOLSREDISTDIR environment variable pointing to:
+"C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\VC\Redist\MSVC\xx.xx.xxxxx" for MSVS 2017 and
+VCINSTALLDIR environment pointing to "C:\Program Files (x86)\Microsoft Visual Studio\2015\Community\VC\" for MSVS 2015.
-=== Direct X SDK ===
+=== Using the stock Qt SDK===
-In order to compile the Qt5 ''qtbase'' package with MinGW you will also need to install the [https://www.microsoft.com/en-us/download/details.aspx?id=6812 Microsoft DirectX SDK], make sure to open a new command line window after the installation.
+This will skip all Qt packages and use the official Qt builds instead.
+It will work fine for most CMake based recipes but definitely cause problems with QMake based projects.
+You will of course also miss all patches we usually apply to Qt.
+This is only recommended when you know what you are doing and you won't get support for in our channel.
-=== Installing Emerge ===
+To activate the SDK mode adapt the [QtSDK] section in your etc/kdesettings.ini to something like:
-* Start a powershell environment as administrator.
+    [QtSDK]
-* Allow execution of powershell scripts.
+    ## Whether to use prebuild Qt binaries.
-  Set-ExecutionPolicy RemoteSigned
+    Enabled = True
-* Exit the administrator powershell instance.
+    ## The path to the Qt sdk.
-* Start a powershell environment as a user.
+    Path = C:\Qt
-* Install emerge and folow the instructions
+    ## The version of Qt.
- iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/emerge/master/setup/install_emerge.ps1'))
+    Version = 5.9
+    ## The compiler version, if you are not sure what to use, have a look at the directory set in QtSDK/Path.
+    ## The compiler must be of the same type as General/KDECOMPILER.
+    ## If you are using mingw please make sure you have installed the mingw using the Qt installer.
+    Compiler = msvc2017_64
-== Using emerge ==
+== Using Craft ==
-To use emerge you need to start a Powershell window, point that to <tt>KDEROOT\emerge</tt> and run the initalization script. For example:
+To use Craft you need to start a Powershell window, point that to <tt>KDEROOT\craft </tt> and run the initalization script. For example:
-  C:\KDEROOT\emerge\kdeenv.ps1
+  C:\CraftRoot\craft\craftenv.ps1
-This tells emerge about your environment settings (e.g. paths). It will load your configuration from <tt>KDEROOT\etc\kdesettings.ini</tt>. If there are any error messages emerge will not work as expected. The output should look similar to this one (of course with your paths):
+This tells Craft about your environment settings (e.g. paths). It will load your configuration from <tt>CraftRoot\etc\CraftSettings.ini</tt>. 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):
-  PS C:\kderoot\emerge>.\kdeenv.ps1
+  PS C:\CraftRoot\craft>.\craftenv.ps1
-  KDEROOT     : C:\kderoot\emerge
+  Craft               : C:\CraftRoot
-  KDECOMPILER : msvc2015
+  Version             : master
-  KDESVNDIR   : C:\kderoot\download\svn
+  ABI                 : windows-msvc2017_64-cl
-  KDEGITDIR   : C:\kderoot\download\git
+  Download directory  : C:\CraftRoot\download
-  DOWNLOADDIR : C:\kderoot\download
- PYTHONPATH  : C:\kderoot\python
- PS C:\kderoot\emerge>
-=== Common emerge commands ===
+Then [https://community.kde.org/Craft start crafting]
-* '''Installing a package and its dependencies''': Simply run <syntaxhighlight lang="text">emerge packagename</syntaxhighlight>
-* '''Updating an installed package''': Once you have ''packagename'' built, type <syntaxhighlight lang="text">emerge -i packagename</syntaxhighlight> to update <tt>packagename</tt>.