From 05c682b7d3dad37e0540384cdb4f4bc14c234580 Mon Sep 17 00:00:00 2001 From: HuntedByTheIRS Date: Sun, 5 Jul 2026 20:30:00 -0400 Subject: [PATCH] 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. --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b43143b..691f08b 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,14 @@ PeachWM is maintained by [HuntedByTheIRS](https://github.com/HuntedByTheIRS). - LLD linker (for linking; part of LLVM) Install these (and their `-devel` versions if your distro has separate -development packages) and run `make` followed by `doas/sudo make install`, -if you wish to install it (installs to /usr/local/bin/ by default). +development packages). The project requires **Clang** and the **LLD linker** +(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