aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--wiki/Getting-Started.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/wiki/Getting-Started.md b/wiki/Getting-Started.md
index 3cac7c56..4cd416c9 100644
--- a/wiki/Getting-Started.md
+++ b/wiki/Getting-Started.md
@@ -95,6 +95,12 @@ Then, build niri with `cargo build --release`.
Check Cargo.toml for a list of build features.
For example, you can replace systemd integration with dinit integration using `cargo build --release --no-default-features --features dinit,dbus,xdp-gnome-screencast`.
+> [!WARNING]
+> Do NOT build with `--all-features`!
+>
+> Some features are meant only for development use.
+> For example, one of the features enables collection of profiling data into a memory buffer that will grow indefinitely until you run out of memory.
+
### NixOS/Nix
We have a community-maintained flake which provides a devshell with required dependencies. Use `nix build` to build niri, and then run `./results/bin/niri`.