Xournal++ 在 Windows 平台上的编译与打包指南

Xournal++ 在 Windows 平台上的编译与打包指南

xournalpp Xournal++ is a handwriting notetaking software with PDF annotation support. Written in C++ with GTK3, supporting Linux (e.g. Ubuntu, Debian, Arch, SUSE), macOS and Windows 10. Supports pen input from devices such as Wacom Tablets. 项目地址: https://gitcode.com/gh_mirrors/xo/xournalpp

Xournal++ 是一款优秀的开源手写笔记应用程序，支持 PDF 注释、手写识别等功能。本文将详细介绍如何在 Windows 平台上搭建 Xournal++ 的开发环境，完成编译、测试及打包过程。

环境准备

1. 安装必要软件

在开始编译 Xournal++ 之前，需要安装以下基础软件：

1. MSYS2：一个提供 Linux 环境的 Windows 工具集

   • 建议安装到简短且不含空格的路径
   • 例如：C:\msys64

2. NSIS：用于创建 Windows 安装程序

   • 建议使用默认安装路径

2. 更新 MSYS2 系统

打开 MSYS2 控制台（不是 MINGW64 控制台），执行以下更新命令：

pacman -Syuu

该命令需要执行两次，每次执行后需要重新打开 MSYS2 控制台。

安装编译工具链

在 MINGW64 控制台中安装必要的编译工具：

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

安装过程中，如果出现提示，请确认或使用默认选项。

安装项目依赖库

Xournal++ 依赖以下库文件：

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

配置环境变量

为了能够直接运行编译后的程序，需要将以下路径添加到 Windows 系统 PATH 环境变量的顶部：

1. C:\msys64\mingw64\bin
2. C:\msys64\usr\bin

注意：如果 MSYS2 安装在其他路径，请相应调整。

编译与测试

完成上述准备工作后，可以按照标准 CMake 流程进行编译：

1. 创建构建目录
2. 运行 CMake 配置
3. 使用 Ninja 或 Make 进行编译

编译完成后，可以直接运行测试：

./xournalpp.exe

打包发布

Xournal++ 提供了方便的打包脚本，可以生成 Windows 安装包和便携版：

./windows-setup/package.sh

打包完成后，可以在以下位置找到生成的文件：

1. 安装程序：windows-setup/xournalpp-setup.exe
2. 便携版：windows-setup/dist 目录

常见问题解决

1. MSYS2 环境选择错误：

   • 确保使用 MINGW64 环境（控制台标题显示 MINGW64）
   • 不要混淆 MSYS2 和 MINGW64 环境

2. 路径问题：

   • 所有路径不应包含空格
   • 建议使用简短路径

3. 依赖库缺失：

   • 如果运行时提示缺少 DLL，检查 PATH 环境变量是否正确设置
   • 确保所有依赖库都已正确安装

通过以上步骤，您应该能够在 Windows 平台上成功编译和打包 Xournal++。如需更详细的编译参数和选项，可以参考项目文档中的编译指南部分。

xournalpp Xournal++ is a handwriting notetaking software with PDF annotation support. Written in C++ with GTK3, supporting Linux (e.g. Ubuntu, Debian, Arch, SUSE), macOS and Windows 10. Supports pen input from devices such as Wacom Tablets. 项目地址: https://gitcode.com/gh_mirrors/xo/xournalpp