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

From KDE Community Wiki
(28 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 emerge ==
== Setting up craft ==
=== Setting up a compiler ===
=== Installing python ===
Currently emerge supports both the MinGW and Microsoft Visual Studio (msvc) compiler.
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+]  
While MinGW is provided by emerge [https://www.visualstudio.com/ Visual Studio], must be installed by the user.


=== Direct X SDK ===
=== Setting up a powershell ===
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.
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.


=== Installing Emerge ===
You can check the version with <tt>$PSVersionTable.PSVersion</tt> .
* Start a powershell environment as administrator.
* Allow execution of powershell scripts.
  Set-ExecutionPolicy RemoteSigned
* Exit the administrator powershell instance.
* Start a powershell environment as a user.
* 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 ==
[https://www.microsoft.com/en-us/download/details.aspx?id=50395 Download Powershell]
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
=== Setting up a compiler ===
Currently Craft supports both the MinGW and Microsoft Visual Studio (msvc) compiler.
While MinGW can be installed by Craft, [https://www.visualstudio.com/ Visual Studio] must be installed independently by the user.


This tells emerge about your environment settings (e.g. paths). It will load your configuration from <tt>KDEROOT\etc\kdesettings.ini</tt>. It should not give any error messages, otherwise emerge will not work as expected. The output should look similar to this one (of course with your paths):
=== 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 [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.


PS C:\kderoot\emerge>.\kdeenv.ps1
=== Installing Craft===
KDEROOT    : C:\kderoot\emerge
* Start a powershell environment.
KDECOMPILER : msvc2015
* Allow execution of powershell scripts.
KDESVNDIR  : C:\kderoot\download\svn
   Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
KDEGITDIR   : C:\kderoot\download\git
* Install Craft and folow the instructions
DOWNLOADDIR : C:\kderoot\download
  iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
  PYTHONPATH  : C:\kderoot\python
PS C:\kderoot\emerge>


=== Installing the base system ===
== Using Craft ==
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:
To use Craft you need to start a Powershell window, point that to <tt>KDEROOT\craft </tt> and run the initalization script. For example:


* 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.
  C:\CraftRoot\craft\craftenv.ps1
* Enter <tt>emerge frameworks</tt>. This will checkout, compile and install the kde frameworks 5 modules.


You will now have successfully installed a base KDE system and can now install other KDE modules as required.
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):


Every time you want to update or install a package, you should first update your emerge checkout (simply run
PS C:\CraftRoot\craft>.\craftenv.ps1
  cd C:\kderoot\emerge
Craft Root          : C:\CraftRoot
  git pull
Craft              : R:\
to ensure you are using the latest package recipes.
Version            : master
ABI                : windows-msvc2017_64-cl
  Svn directory      : C:\CraftRoot\download\svn
  Git directory      : Q:\
Download directory  : C:\CraftRoot\download


=== Common emerge commands ===
==Using Craft with Qt Creator==
* '''Installing a package and its dependencies''': Simply run <syntaxhighlight lang="text">emerge packagename</syntaxhighlight>
To compile from within Qt Creator, I need to set up a kit.
* '''Updating an installed package''': Once you have ''packagename'' built, type <syntaxhighlight lang="text">emerge -i packagename</syntaxhighlight> to update <tt>packagename</tt>.
This is an example for mingw64.
* Add a cmake if none is set: R:\dev-utils\cmake\bin\cmake.exe
* Add a debugger: R:\mingw64\bin\gdb.exe
* Add a C++ compiler and a C compiler. Both: R:\mingw64\bin\gcc.exe
** Ensure that the ABI is correctly set
* Add a Qt: R:\bin\qmake.exe
* Add a kit with all of the above
* Use the kit on a project

Revision as of 11:38, 12 November 2017

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

Using Craft with Qt Creator

To compile from within Qt Creator, I need to set up a kit. This is an example for mingw64.

  • Add a cmake if none is set: R:\dev-utils\cmake\bin\cmake.exe
  • Add a debugger: R:\mingw64\bin\gdb.exe
  • Add a C++ compiler and a C compiler. Both: R:\mingw64\bin\gcc.exe
    • Ensure that the ABI is correctly set
  • Add a Qt: R:\bin\qmake.exe
  • Add a kit with all of the above
  • Use the kit on a project