docs(README): clarify Clang+LLD requirements and build targets

Improve the build instructions to explicitly call out Clang and LLD
as required dependencies, and differentiate between development builds
(make) and production builds (make release) with what each provides.
This commit is contained in:
2026-07-05 20:30:00 -04:00
parent 79e7e26a49
commit 05c682b7d3
+8 -2
View File
@@ -42,8 +42,14 @@ PeachWM is maintained by [HuntedByTheIRS](https://github.com/HuntedByTheIRS).
- LLD linker (for linking; part of LLVM) - LLD linker (for linking; part of LLVM)
Install these (and their `-devel` versions if your distro has separate Install these (and their `-devel` versions if your distro has separate
development packages) and run `make` followed by `doas/sudo make install`, development packages). The project requires **Clang** and the **LLD linker**
if you wish to install it (installs to /usr/local/bin/ by default). (both part of LLVM; install the `clang` and `lld` packages for your distro).
For a development build with debug symbols and sanitizers, run `make` (which
uses the `all` target). For a production install, use `make release` to get an
optimized, stripped binary with LTO and linker hardening.
Then run `doas/sudo make install` to install to `/usr/local/bin` by default.
## SceneFX ## SceneFX