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

From KDE Community Wiki
m (→‎Using emerge: commas)
(30 intermediate revisions by 8 users not shown)
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 a embedded Python version sufficient for most packages, we recommend a full installation of Python. The current version is 3.6. [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 with <tt>$PSVersionTable.PSVersion</tt> .
 
[https://www.microsoft.com/en-us/download/details.aspx?id=50395 Download Powershell]
or
[https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell-core-on-windows?view=powershell-5.1 Download Powershell Core]


== Setting up emerge ==
=== Setting up a compiler ===
=== 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 ===
=== Direct X 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.
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.


=== Installing Emerge ===
=== Installing Craft===
* Start a powershell environment as administrator.
* Start a powershell environment.
* Allow execution of powershell scripts.
* Allow execution of powershell scripts.
   Set-ExecutionPolicy RemoteSigned
   Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
* Exit the administrator powershell instance.
* Install Craft and folow the instructions
* Start a powershell environment as a user.
  iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
* Install emerge and folow the instructions
  iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/emerge/master/setup/install_emerge.ps1'))
 
== Using emerge ==
To use emerge you need to start a Powershell window, point that to <tt>KDEROOT\emerge</tt> and run the initalization script. For example:
 
C:\KDEROOT\emerge\kdeenv.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):


PS C:\kderoot\emerge>.\kdeenv.ps1
=== Using the stock Qt SDK===
KDEROOT    : C:\kderoot\emerge
This will skip all Qt packages and use the official Qt builds instead.
KDECOMPILER : msvc2015
It will work fine for most CMake based recipes but definitely cause problems with QMake based projects.
KDESVNDIR  : C:\kderoot\download\svn
You will of course also miss all patches we usually apply to Qt.
KDEGITDIR  : C:\kderoot\download\git
This is only recommended when you know what you are doing and you won't get support for in our channel.
DOWNLOADDIR : C:\kderoot\download
PYTHONPATH  : C:\kderoot\python
PS C:\kderoot\emerge>


=== Installing the base system ===
To activate the SDK mode adapt the [QtSDK] section in your etc/kdesettings.ini to something like:
You are now ready to start building KDE. It is recommended to do so progressively, relying on emerge to automatically resolve the required dependencies at each set step:
    [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


* Enter <tt>emerge qt5</tt>.  This will fetch and install Windows versions of numerous UNIX-like utilities and libraries, then checkout, compile, and install Qt.  This will take up to several hours.
== Using Craft ==
* Enter <tt>emerge frameworks</tt>.  This will checkout, compile, and install the kde frameworks 5 modules.
To use Craft you need to start a Powershell window, point that to <tt>KDEROOT\craft </tt> and run the initalization script. For example:


You will now have successfully installed a base KDE system and can now install other KDE modules as required.
C:\CraftRoot\craft\craftenv.ps1


Every time you want to update or install a package you should first update your emerge checkout (simply run
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):
cd C:\kderoot\emerge
git pull
to ensure you are using the latest package recipes.


=== Common emerge commands ===
PS C:\CraftRoot\craft>.\craftenv.ps1
* '''Installing a package and its dependencies''': Simply run <syntaxhighlight lang="text">emerge packagename</syntaxhighlight>
Craft Root          : C:\CraftRoot
* '''Updating an installed package''': Once you have ''packagename'' built, type <syntaxhighlight lang="text">emerge -i packagename</syntaxhighlight> to update <tt>packagename</tt>.
Craft              : R:\
Version            : master
ABI                : windows-msvc2017_64-cl
Svn directory      : C:\CraftRoot\download\svn
Git directory      : Q:\
Download directory  : C:\CraftRoot\download

Revision as of 11:35, 2 February 2018

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 a embedded Python version sufficient for most packages, we recommend a full installation of Python. The current version is 3.6. 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 with $PSVersionTable.PSVersion .

Download Powershell or Download Powershell Core

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

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.

Installing Craft

  • Start a powershell environment.
  • Allow execution of powershell scripts.
 Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
  • Install Craft and folow the instructions
iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))


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 Root          : C:\CraftRoot
Craft               : R:\
Version             : master
ABI                 : windows-msvc2017_64-cl
Svn directory       : C:\CraftRoot\download\svn
Git directory       : Q:\
Download directory  : C:\CraftRoot\download