From 236abd9d9da14d614f9f36f1469ff90f441ba167 Mon Sep 17 00:00:00 2001 From: Bill Sun Date: Wed, 10 Jan 2024 22:43:46 -0800 Subject: Add Nix Flake (#77) * Add Nix Flake Co-authored-by: Bryce Berger * Describe nix flake in readme * Add `niri-config` to build source list * Add maintainer info Add comment at top to indicate the Nix Flake file is community maintained. * Clarify Nix/NixOS README instructions * Shorten Nix/NixOS build instructions Co-authored-by: Ivan Molodetskikh * Move NixOS installation instruction to "Tip" section --------- Co-authored-by: Bryce Berger Co-authored-by: Ivan Molodetskikh --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1f49ae76..77436afb 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ When a monitor disconnects, its workspaces will move to another monitor, but upo > [!TIP] > For Fedora users, there's a COPR with built and packaged niri: https://copr.fedorainfracloud.org/coprs/yalter/niri/ > -> NixOS users, check out https://github.com/sodiboo/niri-flake +> For NixOS users, check out https://github.com/sodiboo/niri-flake First, install the dependencies for your distribution. @@ -57,6 +57,16 @@ First, install the dependencies for your distribution. Next, build niri with `cargo build --release`. +### 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`. + +If you're not on NixOS, you may need [NixGL](https://github.com/nix-community/nixGL) to run the resulting binary: + +``` +nix run --impure github:guibou/nixGL -- ./results/bin/niri +``` + ## Installation The recommended way to install and run niri is as a standalone desktop session. -- cgit