WindowsBuild.md

Windows Build

Install Dependencies

Xournal++ requires the following software to build:

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 the MINGW64 console. All following steps in this document happen in this console, unless specified otherwise.

Update MSYS2

Open a MSYS2 console (not the MINGW64 console -- close them if you have any open) and run the following command twice. Reopen the MSYS2 console each time you run the command.

pacman -Syuu

Install Build tools

pacman -S \
  mingw-w64-x86_64-toolchain \
  mingw-w64-x86_64-cmake \
  mingw-w64-x86_64-ninja \
  mingw-w64-x86_64-imagemagick \
  mingw-w64-x86_64-gettext \
  patch \
  make \
  git

If prompted, confirm or use 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 \
  mingw-w64-x86_64-lua \
  mingw-w64-x86_64-portaudio

If prompted, confirm or use all default values.

Building and Testing

See Compile.md

Modify Path Environment Variable

Add C:\msys64\mingw64\bin and C:\msys64\usr\bin to the top of your PATH environment variable in the Windows Advanced system settings (assuming default installation folder for MSYS2).

You can now run Xournal++ with

./xournalpp.exe

or package it in an installer (see below).

Packaging and Setup

Create the installer with

./windows-setup/package.sh

The installer will be located at windows-setup/xournalpp-setup.exe. This command will also create a portable version of Xournal++ located in windows-setup/dist.