Chapter 2. Setup and Build Instructions

Table of Contents

2.1. Automatic development setup (tools/setup-dev)
2.2. UN*X
2.2.1. Build environment setup
2.2.2. Building
2.2.3. Optional: Install
2.2.4. Optional: Create User’s and Developer’s Guide
2.2.5. Optional: Create an installable or source code package
2.2.6. Troubleshooting during the build and install on Unix
2.3. Windows
2.3.1. Using Microsoft Visual Studio (recommended)
2.3.2. Using MinGW-w64 with MSYS2
2.3.3. Using WSL2 on a Windows Host
2.3.4. Cross-compilation using Linux

2.1. Automatic development setup (tools/setup-dev)

If you want a guided setup for dependencies and git hooks, run the helper scripts in the source tree root:

  • Linux: tools/setup-dev.sh configures the commit template and hooks, then offers to run the distro-specific install script (Debian-based by default; Alpine, Arch, and RPM-based distros are auto-detected when possible).
  • macOS: tools/setup-dev.sh configures hooks and asks whether to run the Homebrew setup (tools/macos-setup-brew.sh, default) or the non-Homebrew script (tools/macos-setup.sh).
  • Windows / MSYS2 / MinGW: use tools/setup-dev.ps1 (PowerShell) to configure hooks; follow Section 2.3, “Windows” for platform setup details.