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

From KDE Community Wiki
No edit summary
No edit summary
Line 27: Line 27:
  iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
  iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))


== Using Craft ==
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:\CraftRoot\craft\craftenv.ps1
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:\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


=== Using the Qt SDK===
=== Using the stock Qt SDK===
This will skip all Qt packages and use the official Qt builds instead.
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.
It will work fine for most CMake based recipes but definitely cause problems with QMake based projects.
Line 61: Line 46:
     ## If you are using mingw please make sure you have installed the mingw using the Qt installer.
     ## If you are using mingw please make sure you have installed the mingw using the Qt installer.
     Compiler = msvc2017_64
     Compiler = msvc2017_64
== Using Craft ==
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:\CraftRoot\craft\craftenv.ps1
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:\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

Revision as of 11:02, 30 January 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

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