aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBill Sun <billksun@gmail.com>2024-01-10 22:43:46 -0800
committerGitHub <noreply@github.com>2024-01-10 22:43:46 -0800
commit236abd9d9da14d614f9f36f1469ff90f441ba167 (patch)
tree45905d916fec45f683fc1a76975cccf77750ff0d /README.md
parentb2df3e104f2375af10c0f891eb82253545b952e1 (diff)
downloadniri-236abd9d9da14d614f9f36f1469ff90f441ba167.tar.gz
niri-236abd9d9da14d614f9f36f1469ff90f441ba167.tar.bz2
niri-236abd9d9da14d614f9f36f1469ff90f441ba167.zip
Add Nix Flake (#77)
* Add Nix Flake Co-authored-by: Bryce Berger <bryce.z.berger@gmail.com> * 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 <yalterz@gmail.com> * Move NixOS installation instruction to "Tip" section --------- Co-authored-by: Bryce Berger <bryce.z.berger@gmail.com> Co-authored-by: Ivan Molodetskikh <yalterz@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
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.