WindowsBuild.md

Xournal++ Windows Build

Preparation

1. Install MSYS2 to a short path without spaces.
2. Install NSIS to the standard directory.
3. Start Mingw-w64 64bit. (Always check if it says MINGW64 - not 32bit and not MSYS2)

This will open a console. All following steps happen in this console.

Update MSYS2

Do this multiple times, close the Terminal after each update

pacman -Syuu

Install GIT

pacman -S git

Install Build tools

pacman -S mingw-w64-x86_64-toolchain \
          mingw-w64-x86_64-cmake \
          mingw-w64-x86_64-make \
          mingw-w64-x86_64-ninja \
          patch \
          make \
          tar \
          mingw-w64-x86_64-cppunit

-> press enter multiple times / confirm all default values

Install dependencies

pacman -S mingw-w64-x86_64-poppler \
          mingw-w64-x86_64-gtk3 \
          mingw-w64-x86_64-libsndfile \
          mingw-w64-x86_64-libzip

-> press enter multiple times / confirm all default values

Get sources

git clone https://github.com/xournalpp/xournalpp.git
cd xournalpp/

Install sndfile / PortAudio

Build/Install portaudio with

windows-setup/build-portaudio.sh

Install Lua

Build/Install lua with

windows-setup/build-lua.sh

Build Xournal++

mkdir build
cd build/
cmake ..
cmake --build .

You can run Xournal++ with

./src/xournalpp.exe

or package it in an installer (see below).

Packaging and Setup

Create the installer with

windows-setup/build-setup.sh

The installer will be located at windows-setup/xournalpp-setup.exe