Skip to content

Latest commit

 

History

History
207 lines (151 loc) · 5.13 KB

COMPILE.md

File metadata and controls

207 lines (151 loc) · 5.13 KB
Raw

Compiling Merkaartor

These are the instructions for compiling Merkaartor from git source. Here is the short version, given you have all the dependencies and are familiar with your build environment:

$ git clone https://github.com/openstreetmap/merkaartor.git && cd merkaartor
$ mkdir build && cd build && cmake ..
$ make -j8

And run it using:

$ ./merkaartor

If this is not enough, here are more detailed instructions:

Prerequisites

You will need the following packages installed:

  • Working C++ compiler
  • Qt 5.9 or newer
  • Proj 6.x or newer
  • GDAL (2.0.0 or newer for GDAL exports)
  • Exiv2 (for geoimage support)
  • (For Windows Installer) NSIS-3
  • CMake 3.19.0 or newer

The OS specifics will be explained further down.

Linux

Install the above packages using your package manager. For Debian/Ubuntu, this would look like this:

 $ sudo apt-get install build-essential libgdal-dev libproj-dev libexiv2-dev cmake

Or for Qt5:

 $ sudo apt-get install qt5-default libqt5xml5* libqt5network5* libqt5gui5* libqt5svg5* libqt5webkit5* libqt5quick5* qtdeclarative5-dev qttools5-dev qtbase5-dev qtchooser

Windows (32bit/64bit)

In both cases, you will need to download MSYS2 for your architecture, and install some packages from msys shell (msys2_shell.bat).

For 32bit, they are (the w64 is not a bug!):

$ pacman -S base-devel \
	msys/git \
	mingw32/mingw-w64-i686-gcc \
	mingw32/mingw-w64-i686-qt5 \
	mingw32/mingw-w64-i686-gdal \
	mingw32/mingw-w64-i686-proj \
	mingw32/mingw-w64-i686-openjpeg2 \
	mingw32/mingw-w64-i686-json-c \
	mingw64/mingw-w64-i686-exiv2 \
    mingw64/mingw-w64-i686-cmake

For 64bit, they are:

$ pacman -S base-devel \
	msys/git \
	mingw64/mingw-w64-x86_64-gcc \
	mingw64/mingw-w64-x86_64-qt5 \
	mingw64/mingw-w64-x86_64-gdal \
	mingw64/mingw-w64-x86_64-proj \
	mingw64/mingw-w64-x86_64-openjpeg2 \
	mingw64/mingw-w64-x86_64-json-c \
	mingw64/mingw-w64-x86_64-exiv2 \
    mingw64/mingw-w64-x86_64-cmake

Done? Continue to the next step, but run a different msys shell, the mingw32 or mingw64, based on your architecture. Note that if you'll run mingw32 shell from 64bit msys installtion, strange stuff will happen, so don't do it.

Mac OS X

You will need functional xcode (or other c++ compiler), and libraries installed from homebrew.

brew install gdal proj qt

If you want to use qt5, you need to force link it, as homebrew guys consider Qt4 the default:

brew install qt5 gdal proj exiv2 cmake
brew link --force qt5

You can do without linking, but you will need to manually supply some paths to the build environment.

Compilation

Clone the repository

$ git clone https://github.com/openstreetmap/merkaartor.git && cd merkaartor

By default, this is the latest development version. If you want to use an older one, you have to checkout the commit/tag:

$ git checkout 0.17.0

Please, use this only for testing (for example, if some feature does not work, but it did in older release and you want to check which one), never report bugs for older versions.

Run cmake

$ mkdir build && cd build && cmake ..
$ make -jX

There are a few build options that can be passed to cmake to configure features compiled-in. See the cmake output for a full list (or use CMake GUI to configure it):

-- Build options (use -DOPT=ON/OFF to enable/disable):
--  * ZBAR        OFF
--  * GEOIMAGE    ON
--  * GPSD        OFF
--  * WEBENGINE   OFF

For example, compiling in support for GPSD would be:

cmake .. -DGPSD=ON

Run qmake

Note: qmake support is deprecatd and will be removed in the next release. Please use cmake instructions above whenever possible.

$ qmake -r

Note that you need the Qt4 or Qt5 version of qmake - running the Qt3 version will generate incorrect makefiles. If both are installed, take care to run the correct version. For example, on Fedora/Debian run

$ qmake-qt4

and on (K)ubuntu run

$ /usr/share/qt4/bin/qmake

There are some parameters you can pass to qmake to customize build:

Parameter Meaning
PREFIX= base prefix for installation (unix only)
TRANSDIR_MERKAARTOR= where will the Merkaartor translations be installed
TRANSDIR_SYSTEM= where your global Qt translation directory is
NODEBUG=1 release target
USEWEBENGINE=1 enable use of WebEngine (required for some external plugins)
SYSTEM_QTSA use system copy of qtsingleapplication instead of internal

Run make

On Windows: $ make release On other platforms: $ make Debug build: $ make debug

On most Windows installations, debug is the default and we need to specify the release manually. Sorry about that.

Done!

If you are lucky, you'll find an executable in the binaries subdirectory. Otherwise, check our github page, especially check the issues and possibly report yours.

Packaging

The project uses CPack to generate binary packages. In the build directory, invoke the package build target:

$ make package