Skip to content

docs: add a full "Building on Linux" section - #1

Merged
Trooper-code merged 1 commit into
mainfrom
docs/building-on-linux
Nov 14, 2026
Merged

Trooper-code merged 1 commit into
mainfrom
docs/building-on-linux

Conversation

@Trooper-code

@Trooper-code Trooper-code commented Nov 14, 2026 •

Copy link
Copy Markdown
Owner

Replaces the two-line Linux build note under Building from source with a step-by-step Building on Linux section, and adds it to the table of contents.

What it covers

  • Compiler and graphics header packages for Debian/Ubuntu/Mint/Pop!_OS/WSL (the same packages CI installs), Fedora and Arch. The Fedora and Arch lists are labelled as not checked by CI.
  • Installing Go, and how Go 1.21+ downloads the go.mod version by itself. Plus an exact-version install that reads the version from go.mod, so it won't go stale.
  • Building, VERSION= stamping, running, and where settings and received files end up.
  • Optional: the same go vet/go test checks as CI, release-style .tar.gz + .sha256 packaging, and a .desktop app-menu entry.
  • A note on building in WSL (it makes a Linux binary that runs through WSLg, and relay hosting won't work from inside WSL).
  • A troubleshooting table for missing gcc or headers, an old Go, cgo switched off, a lost executable bit, and no OpenGL in VMs/SSH.

Also updates the package list in build.sh's header comment to include libxkbcommon-dev libwayland-dev, to match the CI workflow.

How it was checked

  • sh -n build.sh passes, the awk that reads the Go version from go.mod prints 1.27.1, the .desktop snippet was run in a throwaway home folder, and all the new anchor links resolve.
  • I couldn't do a full build in my sandbox because it can't reach the Go module proxy. The Ubuntu steps match the CI workflow, which builds this on every push.

Replaces the two-line Linux build note with a step-by-step guide:

- compiler and graphics header packages for Debian/Ubuntu (same as CI),
  Fedora and Arch
- installing Go, including how Go 1.21+ fetches the go.mod version itself
- building, version stamping, running, and where settings/downloads go
- optional: CI checks, release-style packaging, a .desktop menu entry
- a note on building inside WSL
- a troubleshooting table for common cgo/header/OpenGL errors

Also updates the package list in build.sh's header comment to include
the Wayland headers GLFW 3.4 needs, matching the CI workflow.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01D2Ppju4rH8FQpuXyDyWfaa
@Trooper-code
Trooper-code merged commit 5d94f41 into main Nov 14, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants