README.MSYS2.txt

About
=====
This file describes the compilation of libosmscout under the MSYS2 (64bit) environment.

About MSYS2
===========

MSYS2 allows you to build and run Unix based applications under Windows. It allows
you to build libosmscout using autoconf tools and gcc under Windows.

For more information regarding MSYS2 see:
* https://msys2.github.io/ 
* https://sourceforge.net/p/msys2/wiki/MSYS2%20installation/

Required Packages
=================

We are using the MINGW64 - not the MSYS - environment, make sure to use the right shell
(the MINGW64 one!) for building.

Besides the base configuration as supplied by the installer and the following mandatory steps
you need the following packages for building libosmscout:
* git
* autoconf
* automake
* mingw-w64-x86_64-toolchain
* mingw-w64-x86_64-libtool

For libosmscout-import you need additonally:
* mingw-w64-x86_64-protobuf
* mingw-w64-x86_64-libxml2

For the cairo backend you need additionally:
* mingw-w64-x86_64-cairo
* mingw-w64-x86_64-pango

For the Qt5 backend you need additionally:
* mingw-w64-x86_64-qt5

For cmake you need additionally:
* mingw-w64-x86_64-cmake
* mingw-w64-x86_64-cmake-extra-modules
* mingw-w64-x86_64-ninja

packages can be installed using

  pacman -S <package>

Building
========
* Source the setupMSYS2.sh in the top level directory. It sets  the pkg-config
  path to the right values for the given shell session.
* For OSMScout2 you have to build the release version, the debug version
  crashes for yet unknown reasons.  
* You have to copy the required libosmscout DLLs (libosmsocut, libosmsocut-map,
  libosmscout-map-qt) to the OSMScout2 release sub directory to get them found.
  
Other recomendations
====================
Configure git to handle crlf line endings automatically:

  git config --global core.autocrlf true