mirror of
https://github.com/YaLTeR/niri.git
synced 2024-09-11 12:35:58 +03:00
Update README.md
This commit is contained in:
parent
40c85da102
commit
616055e205
52
README.md
52
README.md
@ -1,8 +1,33 @@
|
|||||||
# niri
|
<h1 align="center">niri</h1>
|
||||||
|
<p align="center">A scrollable-tiling Wayland compositor.</p>
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://matrix.to/#/#niri:matrix.org"><img alt="Matrix" src="https://img.shields.io/matrix/niri%3Amatrix.org?logo=matrix&label=matrix"></a>
|
||||||
|
<a href="https://github.com/YaLTeR/niri/blob/main/LICENSE"><img alt="GitHub License" src="https://img.shields.io/github/license/YaLTeR/niri"></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>
|
||||||
|
|
||||||
A scrollable-tiling Wayland compositor.
|
![](https://github.com/YaLTeR/niri/assets/1794388/16f87a4a-afac-49aa-b3e6-5e6f16c943a9)
|
||||||
|
|
||||||
![](https://github.com/YaLTeR/niri/assets/1794388/e35fd9e1-105b-4bd5-94c9-207fd6fb3c18)
|
## About
|
||||||
|
|
||||||
|
Windows are arranged in columns on an infinite strip going to the right.
|
||||||
|
Opening a new window never causes existing windows to resize.
|
||||||
|
|
||||||
|
Every monitor has its own separate window strip.
|
||||||
|
Windows can never "overflow" onto an adjacent monitor.
|
||||||
|
|
||||||
|
Since windows go left-to-right horizontally, workspaces are arranged vertically.
|
||||||
|
Every monitor has an independent set of workspaces, and there's always one empty workspace present all the way down.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Scrollable tiling
|
||||||
|
- Dynamic workspaces like in GNOME
|
||||||
|
- Built-in screenshot UI
|
||||||
|
- Monitor screencasting through xdg-desktop-portal-gnome
|
||||||
|
- Touchpad gesture to switch workspaces
|
||||||
|
- Configurable layout: gaps, borders, struts, window sizes
|
||||||
|
- Live-reloading config
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
@ -12,21 +37,12 @@ Have your waybars and fuzzels ready: niri is not a complete desktop environment.
|
|||||||
|
|
||||||
https://github.com/YaLTeR/niri/assets/1794388/5d355694-7b06-4f00-8920-8dce54a8721c
|
https://github.com/YaLTeR/niri/assets/1794388/5d355694-7b06-4f00-8920-8dce54a8721c
|
||||||
|
|
||||||
## Idea
|
## Inspiration
|
||||||
|
|
||||||
Niri implements scrollable tiling, heavily inspired by [PaperWM].
|
Niri is heavily inspired by [PaperWM] which implements scrollable tiling on top of GNOME Shell.
|
||||||
Windows are arranged in columns on an infinite strip going to the right.
|
|
||||||
Every column takes up a full monitor worth of height, divided among its windows.
|
|
||||||
|
|
||||||
With multiple monitors, every monitor has its own separate window strip.
|
One of the reasons that prompted me to try writing my own compositor is being able to properly separate the monitors.
|
||||||
Windows can never "overflow" onto an adjacent monitor.
|
Being a GNOME Shell extension, PaperWM has to work against Shell's global window coordinate space to prevent windows from overflowing.
|
||||||
|
|
||||||
This is one of the reasons that prompted me to try writing my own compositor.
|
|
||||||
PaperWM is a solid implementation, but, being a GNOME Shell extension, it has to work around Shell's global window coordinate space to prevent windows from overflowing.
|
|
||||||
|
|
||||||
Niri also has dynamic workspaces which work similar to GNOME Shell.
|
|
||||||
Since windows go left-to-right horizontally, workspaces are arranged vertically.
|
|
||||||
Every monitor has an independent set of workspaces, and there's always one empty workspace present all the way down.
|
|
||||||
|
|
||||||
Niri tries to preserve the workspace arrangement as much as possible upon disconnecting and connecting monitors.
|
Niri tries to preserve the workspace arrangement as much as possible upon disconnecting and connecting monitors.
|
||||||
When a monitor disconnects, its workspaces will move to another monitor, but upon reconnection they will move back to the original monitor.
|
When a monitor disconnects, its workspaces will move to another monitor, but upon reconnection they will move back to the original monitor.
|
||||||
@ -176,6 +192,10 @@ Please use the default configuration file as the starting point for your custom
|
|||||||
|
|
||||||
Niri will live-reload most of the configuration settings, like key binds or gaps or output modes, as you change the config file.
|
Niri will live-reload most of the configuration settings, like key binds or gaps or output modes, as you change the config file.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
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
|
[mako]: https://github.com/emersion/mako
|
||||||
[OBS]: https://flathub.org/apps/com.obsproject.Studio
|
[OBS]: https://flathub.org/apps/com.obsproject.Studio
|
||||||
|
Loading…
Reference in New Issue
Block a user