mirror of
https://github.com/YaLTeR/niri.git
synced 2024-09-11 12:35:58 +03:00
Move info from README to Getting Started wiki page
This commit is contained in:
Ivan Molodetskikh
parent
ba44aeda4a
commit
4fc80124ad
144
README.md
144
README.md
@ -6,6 +6,10 @@
|
|||||||
<a href="https://github.com/YaLTeR/niri/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/YaLTeR/niri?logo=github"></a>
|
<a href="https://github.com/YaLTeR/niri/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/YaLTeR/niri?logo=github"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://github.com/YaLTeR/niri/wiki/Getting-Started">Getting Started</a> | <a href="https://github.com/YaLTeR/niri/wiki/Configuration:-Overview">Configuration</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## About
|
## About
|
||||||
@ -40,11 +44,9 @@ https://github.com/YaLTeR/niri/assets/1794388/5d355694-7b06-4f00-8920-8dce54a872
|
|||||||
## Status
|
## Status
|
||||||
|
|
||||||
A lot of the essential functionality is implemented, plus some goodies on top.
|
A lot of the essential functionality is implemented, plus some goodies on top.
|
||||||
Feel free to give niri a try.
|
Feel free to give niri a try: follow the instructions on the [Getting Started](https://github.com/YaLTeR/niri/wiki/Getting-Started) wiki page.
|
||||||
Have your [waybar]s and [fuzzel]s ready: niri is not a complete desktop environment.
|
Have your [waybar]s and [fuzzel]s ready: niri is not a complete desktop environment.
|
||||||
|
|
||||||
Note that NVIDIA GPUs might have rendering issues.
|
|
||||||
|
|
||||||
## Inspiration
|
## Inspiration
|
||||||
|
|
||||||
Niri is heavily inspired by [PaperWM] which implements scrollable tiling on top of GNOME Shell.
|
Niri is heavily inspired by [PaperWM] which implements scrollable tiling on top of GNOME Shell.
|
||||||
@ -52,147 +54,11 @@ Niri is heavily inspired by [PaperWM] which implements scrollable tiling on top
|
|||||||
One of the reasons that prompted me to try writing my own compositor is being able to properly separate the monitors.
|
One of the reasons that prompted me to try writing my own compositor is being able to properly separate the monitors.
|
||||||
Being a GNOME Shell extension, PaperWM has to work against Shell's global window coordinate space to prevent windows from overflowing.
|
Being a GNOME Shell extension, PaperWM has to work against Shell's global window coordinate space to prevent windows from overflowing.
|
||||||
|
|
||||||
## Packages
|
|
||||||
|
|
||||||
There are several community-maintained distribution packages that you can use to install niri.
|
|
||||||
Here are some of them:
|
|
||||||
|
|
||||||
- Fedora COPR (I maintain this one myself): https://copr.fedorainfracloud.org/coprs/yalter/niri/
|
|
||||||
- AUR: [niri](https://aur.archlinux.org/packages/niri), [niri-bin](https://aur.archlinux.org/packages/niri-bin), [niri-git](https://aur.archlinux.org/packages/niri-git)
|
|
||||||
- NixOS Flake: https://github.com/sodiboo/niri-flake
|
|
||||||
- FreeBSD Ports: https://www.freshports.org/x11-wm/niri
|
|
||||||
- Gentoo GURU: https://gpo.zugaina.org/Overlays/guru/gui-wm/niri
|
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
First, install the dependencies for your distribution.
|
|
||||||
|
|
||||||
- Ubuntu 23.10:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo apt-get install -y gcc clang libudev-dev libgbm-dev libxkbcommon-dev libegl1-mesa-dev libwayland-dev libinput-dev libdbus-1-dev libsystemd-dev libseat-dev libpipewire-0.3-dev libpango1.0-dev
|
|
||||||
```
|
|
||||||
|
|
||||||
- Fedora:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo dnf install gcc libudev-devel libgbm-devel libxkbcommon-devel wayland-devel libinput-devel dbus-devel systemd-devel libseat-devel pipewire-devel pango-devel cairo-gobject-devel clang
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, get latest stable Rust: https://rustup.rs/
|
|
||||||
|
|
||||||
Then, 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.
|
|
||||||
To do that, put files into the correct directories according to this table.
|
|
||||||
|
|
||||||
| File | Destination |
|
|
||||||
| ---- | ----------- |
|
|
||||||
| `target/release/niri` | `/usr/bin/` |
|
|
||||||
| `resources/niri-session` | `/usr/bin/` |
|
|
||||||
| `resources/niri.desktop` | `/usr/share/wayland-sessions/` |
|
|
||||||
| `resources/niri-portals.conf` | `/usr/share/xdg-desktop-portal/` |
|
|
||||||
| `resources/niri.service` | `/usr/lib/systemd/user/` |
|
|
||||||
| `resources/niri-shutdown.target` | `/usr/lib/systemd/user/` |
|
|
||||||
|
|
||||||
Doing this will make niri appear in GDM and, presumably, other display managers.
|
|
||||||
|
|
||||||
## Running
|
|
||||||
|
|
||||||
`cargo run --release`
|
|
||||||
|
|
||||||
Inside an existing desktop session, it will run in a window.
|
|
||||||
On a TTY, it will run natively.
|
|
||||||
|
|
||||||
To exit when running on a TTY, press <kbd>Super</kbd><kbd>Shift</kbd><kbd>E</kbd>.
|
|
||||||
|
|
||||||
### Session
|
|
||||||
|
|
||||||
If you followed the recommended installation steps above, niri should appear in your display manager.
|
|
||||||
Starting it from there will run niri as a desktop session.
|
|
||||||
|
|
||||||
The niri session will autostart apps through the systemd xdg-autostart target.
|
|
||||||
You can also autostart systemd services like [mako] by symlinking them into `$HOME/.config/systemd/user/niri.service.wants/`.
|
|
||||||
A step-by-step process for this is explained [on the wiki](https://github.com/YaLTeR/niri/wiki/Example-systemd-Setup).
|
|
||||||
|
|
||||||
Niri also works with some parts of xdg-desktop-portal-gnome.
|
|
||||||
In particular, it supports file choosers and monitor screencasting (e.g. to [OBS]).
|
|
||||||
|
|
||||||
[This wiki page](https://github.com/YaLTeR/niri/wiki/Important-Software) explains how to run important software required for normal desktop use, including portals.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Please check [this wiki page](https://github.com/YaLTeR/niri/wiki/Configuration:-Overview) for an overview of niri configuration.
|
|
||||||
It also links to wiki pages containing thorough documentation for all options with examples.
|
|
||||||
|
|
||||||
## Default Hotkeys
|
|
||||||
|
|
||||||
When running on a TTY, the Mod key is <kbd>Super</kbd>.
|
|
||||||
When running in a window, the Mod key is <kbd>Alt</kbd>.
|
|
||||||
|
|
||||||
The general system is: if a hotkey switches somewhere, then adding <kbd>Ctrl</kbd> will move the focused window or column there.
|
|
||||||
|
|
||||||
| Hotkey | Description |
|
|
||||||
| ------ | ----------- |
|
|
||||||
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>/</kbd> | Show a list of important niri hotkeys |
|
|
||||||
| <kbd>Mod</kbd><kbd>T</kbd> | Spawn `alacritty` (terminal) |
|
|
||||||
| <kbd>Mod</kbd><kbd>D</kbd> | Spawn `fuzzel` (application launcher) |
|
|
||||||
| <kbd>Mod</kbd><kbd>Alt</kbd><kbd>L</kbd> | Spawn `swaylock` (screen locker) |
|
|
||||||
| <kbd>Mod</kbd><kbd>Q</kbd> | Close the focused window |
|
|
||||||
| <kbd>Mod</kbd><kbd>H</kbd> or <kbd>Mod</kbd><kbd>←</kbd> | Focus the column to the left |
|
|
||||||
| <kbd>Mod</kbd><kbd>L</kbd> or <kbd>Mod</kbd><kbd>→</kbd> | Focus the column to the right |
|
|
||||||
| <kbd>Mod</kbd><kbd>J</kbd> or <kbd>Mod</kbd><kbd>↓</kbd> | Focus the window below in a column |
|
|
||||||
| <kbd>Mod</kbd><kbd>K</kbd> or <kbd>Mod</kbd><kbd>↑</kbd> | Focus the window above in a column |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>H</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>←</kbd> | Move the focused column to the left |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>L</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>→</kbd> | Move the focused column to the right |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>J</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>↓</kbd> | Move the focused window below in a column |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>K</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>↑</kbd> | Move the focused window above in a column |
|
|
||||||
| <kbd>Mod</kbd><kbd>Home</kbd> and <kbd>Mod</kbd><kbd>End</kbd> | Focus the first or the last column |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>Home</kbd> and <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>End</kbd> | Move the focused column to the very start or to the very end |
|
|
||||||
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>H</kbd><kbd>J</kbd><kbd>K</kbd><kbd>L</kbd> or <kbd>Mod</kbd><kbd>Shift</kbd><kbd>←</kbd><kbd>↓</kbd><kbd>↑</kbd><kbd>→</kbd> | Focus the monitor to the side |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>H</kbd><kbd>J</kbd><kbd>K</kbd><kbd>L</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>←</kbd><kbd>↓</kbd><kbd>↑</kbd><kbd>→</kbd> | Move the focused column to the monitor to the side |
|
|
||||||
| <kbd>Mod</kbd><kbd>U</kbd> or <kbd>Mod</kbd><kbd>PageDown</kbd> | Switch to the workspace below |
|
|
||||||
| <kbd>Mod</kbd><kbd>I</kbd> or <kbd>Mod</kbd><kbd>PageUp</kbd> | Switch to the workspace above |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>U</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>PageDown</kbd> | Move the focused column to the workspace below |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>I</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>PageUp</kbd> | Move the focused column to the workspace above |
|
|
||||||
| <kbd>Mod</kbd><kbd>1</kbd>–<kbd>9</kbd> | Switch to a workspace by index |
|
|
||||||
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>1</kbd>–<kbd>9</kbd> | Move the focused column to a workspace by index |
|
|
||||||
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>U</kbd> or <kbd>Mod</kbd><kbd>Shift</kbd><kbd>PageDown</kbd> | Move the focused workspace down |
|
|
||||||
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>I</kbd> or <kbd>Mod</kbd><kbd>Shift</kbd><kbd>PageUp</kbd> | Move the focused workspace up |
|
|
||||||
| <kbd>Mod</kbd><kbd>,</kbd> | Consume the window to the right into the focused column |
|
|
||||||
| <kbd>Mod</kbd><kbd>.</kbd> | Expel the focused window into its own column |
|
|
||||||
| <kbd>Mod</kbd><kbd>R</kbd> | Toggle between preset column widths |
|
|
||||||
| <kbd>Mod</kbd><kbd>F</kbd> | Maximize column |
|
|
||||||
| <kbd>Mod</kbd><kbd>C</kbd> | Center column within view |
|
|
||||||
| <kbd>Mod</kbd><kbd>-</kbd> | Decrease column width by 10% |
|
|
||||||
| <kbd>Mod</kbd><kbd>=</kbd> | Increase column width by 10% |
|
|
||||||
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>-</kbd> | Decrease window height by 10% |
|
|
||||||
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>=</kbd> | Increase window height by 10% |
|
|
||||||
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>F</kbd> | Toggle full-screen on the focused window |
|
|
||||||
| <kbd>PrtSc</kbd> | Take an area screenshot. Select the area to screenshot with mouse, then press Space to save the screenshot, or Escape to cancel |
|
|
||||||
| <kbd>Alt</kbd><kbd>PrtSc</kbd> | Take a screenshot of the focused window to clipboard and to `~/Pictures/Screenshots/` |
|
|
||||||
| <kbd>Ctrl</kbd><kbd>PrtSc</kbd> | Take a screenshot of the focused monitor to clipboard and to `~/Pictures/Screenshots/` |
|
|
||||||
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>E</kbd> | Exit niri |
|
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
We have a Matrix chat, feel free to join and ask a question: https://matrix.to/#/#niri:matrix.org
|
We have a Matrix chat, feel free to join and ask a question: https://matrix.to/#/#niri:matrix.org
|
||||||
|
|
||||||
[PaperWM]: https://github.com/paperwm/PaperWM
|
[PaperWM]: https://github.com/paperwm/PaperWM
|
||||||
[mako]: https://github.com/emersion/mako
|
|
||||||
[OBS]: https://flathub.org/apps/com.obsproject.Studio
|
|
||||||
[waybar]: https://github.com/Alexays/Waybar
|
[waybar]: https://github.com/Alexays/Waybar
|
||||||
[fuzzel]: https://codeberg.org/dnkl/fuzzel
|
[fuzzel]: https://codeberg.org/dnkl/fuzzel
|
||||||
|
|
||||||
|
|||||||
125
wiki/Getting-Started.md
Normal file
125
wiki/Getting-Started.md
Normal file
@ -0,0 +1,125 @@
|
|||||||
|
The easiest way to get niri is to install one of the distribution packages.
|
||||||
|
Here are some of them: [Fedora COPR](https://copr.fedorainfracloud.org/coprs/yalter/niri/) (which I maintain myself), [NixOS Flake](https://github.com/sodiboo/niri-flake), and some more from repology below.
|
||||||
|
See the [Building](#building) section if you'd like to compile niri yourself.
|
||||||
|
|
||||||
|
[](https://repology.org/project/niri/versions)
|
||||||
|
|
||||||
|
After installing, start niri from your display manager like GDM.
|
||||||
|
Press <kbd>Super</kbd><kbd>T</kbd> to run a terminal ([Alacritty]) and <kbd>Super</kbd><kbd>D</kbd> to run an application launcher ([fuzzel]).
|
||||||
|
To exit niri, press <kbd>Super</kbd><kbd>Shift</kbd><kbd>E</kbd>.
|
||||||
|
|
||||||
|
If you're not using a display manager, you should run `niri --session` from a TTY.
|
||||||
|
The `--session` flag will make niri import its environment variables globally into systemd and D-Bus, and start its D-Bus services.
|
||||||
|
|
||||||
|
You can also run `niri` inside an existing desktop session.
|
||||||
|
Then it will open as a window, where you can give it a try.
|
||||||
|
|
||||||
|
Next, see the [list of important software](./Important-Software.md) required for normal desktop use, like a notification daemon and portals.
|
||||||
|
Also, check the [configuration overview](./Configuration:-Overview.md) page to get started configuring niri.
|
||||||
|
There you can find links to other pages containing thorough documentation and examples for all options.
|
||||||
|
Finally, the [Xwayland](./Xwayland.md) page explains how to run X11 applications on niri.
|
||||||
|
|
||||||
|
### Virtual Machines
|
||||||
|
|
||||||
|
To run niri in a VM, make sure to enable 3D acceleration.
|
||||||
|
|
||||||
|
## Default Hotkeys
|
||||||
|
|
||||||
|
When running on a TTY, the Mod key is <kbd>Super</kbd>.
|
||||||
|
When running in a window, the Mod key is <kbd>Alt</kbd>.
|
||||||
|
|
||||||
|
The general system is: if a hotkey switches somewhere, then adding <kbd>Ctrl</kbd> will move the focused window or column there.
|
||||||
|
|
||||||
|
| Hotkey | Description |
|
||||||
|
| ------ | ----------- |
|
||||||
|
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>/</kbd> | Show a list of important niri hotkeys |
|
||||||
|
| <kbd>Mod</kbd><kbd>T</kbd> | Spawn `alacritty` (terminal) |
|
||||||
|
| <kbd>Mod</kbd><kbd>D</kbd> | Spawn `fuzzel` (application launcher) |
|
||||||
|
| <kbd>Mod</kbd><kbd>Alt</kbd><kbd>L</kbd> | Spawn `swaylock` (screen locker) |
|
||||||
|
| <kbd>Mod</kbd><kbd>Q</kbd> | Close the focused window |
|
||||||
|
| <kbd>Mod</kbd><kbd>H</kbd> or <kbd>Mod</kbd><kbd>←</kbd> | Focus the column to the left |
|
||||||
|
| <kbd>Mod</kbd><kbd>L</kbd> or <kbd>Mod</kbd><kbd>→</kbd> | Focus the column to the right |
|
||||||
|
| <kbd>Mod</kbd><kbd>J</kbd> or <kbd>Mod</kbd><kbd>↓</kbd> | Focus the window below in a column |
|
||||||
|
| <kbd>Mod</kbd><kbd>K</kbd> or <kbd>Mod</kbd><kbd>↑</kbd> | Focus the window above in a column |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>H</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>←</kbd> | Move the focused column to the left |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>L</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>→</kbd> | Move the focused column to the right |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>J</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>↓</kbd> | Move the focused window below in a column |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>K</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>↑</kbd> | Move the focused window above in a column |
|
||||||
|
| <kbd>Mod</kbd><kbd>Home</kbd> and <kbd>Mod</kbd><kbd>End</kbd> | Focus the first or the last column |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>Home</kbd> and <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>End</kbd> | Move the focused column to the very start or to the very end |
|
||||||
|
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>H</kbd><kbd>J</kbd><kbd>K</kbd><kbd>L</kbd> or <kbd>Mod</kbd><kbd>Shift</kbd><kbd>←</kbd><kbd>↓</kbd><kbd>↑</kbd><kbd>→</kbd> | Focus the monitor to the side |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>H</kbd><kbd>J</kbd><kbd>K</kbd><kbd>L</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>←</kbd><kbd>↓</kbd><kbd>↑</kbd><kbd>→</kbd> | Move the focused column to the monitor to the side |
|
||||||
|
| <kbd>Mod</kbd><kbd>U</kbd> or <kbd>Mod</kbd><kbd>PageDown</kbd> | Switch to the workspace below |
|
||||||
|
| <kbd>Mod</kbd><kbd>I</kbd> or <kbd>Mod</kbd><kbd>PageUp</kbd> | Switch to the workspace above |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>U</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>PageDown</kbd> | Move the focused column to the workspace below |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>I</kbd> or <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>PageUp</kbd> | Move the focused column to the workspace above |
|
||||||
|
| <kbd>Mod</kbd><kbd>1</kbd>–<kbd>9</kbd> | Switch to a workspace by index |
|
||||||
|
| <kbd>Mod</kbd><kbd>Ctrl</kbd><kbd>1</kbd>–<kbd>9</kbd> | Move the focused column to a workspace by index |
|
||||||
|
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>U</kbd> or <kbd>Mod</kbd><kbd>Shift</kbd><kbd>PageDown</kbd> | Move the focused workspace down |
|
||||||
|
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>I</kbd> or <kbd>Mod</kbd><kbd>Shift</kbd><kbd>PageUp</kbd> | Move the focused workspace up |
|
||||||
|
| <kbd>Mod</kbd><kbd>,</kbd> | Consume the window to the right into the focused column |
|
||||||
|
| <kbd>Mod</kbd><kbd>.</kbd> | Expel the focused window into its own column |
|
||||||
|
| <kbd>Mod</kbd><kbd>R</kbd> | Toggle between preset column widths |
|
||||||
|
| <kbd>Mod</kbd><kbd>F</kbd> | Maximize column |
|
||||||
|
| <kbd>Mod</kbd><kbd>C</kbd> | Center column within view |
|
||||||
|
| <kbd>Mod</kbd><kbd>-</kbd> | Decrease column width by 10% |
|
||||||
|
| <kbd>Mod</kbd><kbd>=</kbd> | Increase column width by 10% |
|
||||||
|
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>-</kbd> | Decrease window height by 10% |
|
||||||
|
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>=</kbd> | Increase window height by 10% |
|
||||||
|
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>F</kbd> | Toggle full-screen on the focused window |
|
||||||
|
| <kbd>PrtSc</kbd> | Take an area screenshot. Select the area to screenshot with mouse, then press Space to save the screenshot, or Escape to cancel |
|
||||||
|
| <kbd>Alt</kbd><kbd>PrtSc</kbd> | Take a screenshot of the focused window to clipboard and to `~/Pictures/Screenshots/` |
|
||||||
|
| <kbd>Ctrl</kbd><kbd>PrtSc</kbd> | Take a screenshot of the focused monitor to clipboard and to `~/Pictures/Screenshots/` |
|
||||||
|
| <kbd>Mod</kbd><kbd>Shift</kbd><kbd>E</kbd> | Exit niri |
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
First, install the dependencies for your distribution.
|
||||||
|
|
||||||
|
- Ubuntu 23.10:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo apt-get install -y gcc clang libudev-dev libgbm-dev libxkbcommon-dev libegl1-mesa-dev libwayland-dev libinput-dev libdbus-1-dev libsystemd-dev libseat-dev libpipewire-0.3-dev libpango1.0-dev
|
||||||
|
```
|
||||||
|
|
||||||
|
- Fedora:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo dnf install gcc libudev-devel libgbm-devel libxkbcommon-devel wayland-devel libinput-devel dbus-devel systemd-devel libseat-devel pipewire-devel pango-devel cairo-gobject-devel clang
|
||||||
|
```
|
||||||
|
|
||||||
|
Next, get latest stable Rust: https://rustup.rs/
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
To do that, put files into the correct directories according to this table.
|
||||||
|
|
||||||
|
| File | Destination |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| `target/release/niri` | `/usr/bin/` |
|
||||||
|
| `resources/niri-session` | `/usr/bin/` |
|
||||||
|
| `resources/niri.desktop` | `/usr/share/wayland-sessions/` |
|
||||||
|
| `resources/niri-portals.conf` | `/usr/share/xdg-desktop-portal/` |
|
||||||
|
| `resources/niri.service` | `/usr/lib/systemd/user/` |
|
||||||
|
| `resources/niri-shutdown.target` | `/usr/lib/systemd/user/` |
|
||||||
|
|
||||||
|
Doing this will make niri appear in GDM and other display managers.
|
||||||
|
|
||||||
|
[Alacritty]: https://github.com/alacritty/alacritty
|
||||||
|
[fuzzel]: https://codeberg.org/dnkl/fuzzel
|
||||||
@ -1,4 +1,5 @@
|
|||||||
## Usage
|
## Usage
|
||||||
|
* [Getting Started](./Getting-Started.md)
|
||||||
* [Example systemd Setup](./Example-systemd-Setup.md)
|
* [Example systemd Setup](./Example-systemd-Setup.md)
|
||||||
* [Important Software](./Important-Software.md)
|
* [Important Software](./Important-Software.md)
|
||||||
* [Layer‐Shell Components](./Layer%E2%80%90Shell-Components.md)
|
* [Layer‐Shell Components](./Layer%E2%80%90Shell-Components.md)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user