aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Molodetskikh <yalterz@gmail.com>2024-03-29 14:20:51 +0400
committerIvan Molodetskikh <yalterz@gmail.com>2024-03-29 14:20:51 +0400
commit56a55f1ad1cc0dcc287d6534fadafa34cb7437b4 (patch)
treef1b1031f742a27103953a7aae43068ec2dbae190
parentf7fde74a8d5f676b70f1eb8c8e5a65e76c67edac (diff)
downloadniri-56a55f1ad1cc0dcc287d6534fadafa34cb7437b4.tar.gz
niri-56a55f1ad1cc0dcc287d6534fadafa34cb7437b4.tar.bz2
niri-56a55f1ad1cc0dcc287d6534fadafa34cb7437b4.zip
Improve README
-rw-r--r--README.md8
1 files changed, 3 insertions, 5 deletions
diff --git a/README.md b/README.md
index 271f9b46..d3bbba85 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ When a monitor disconnects, its workspaces will move to another monitor, but upo
- Dynamic workspaces like in GNOME
- Built-in screenshot UI
- Monitor screencasting through xdg-desktop-portal-gnome
+ - You can [block out](https://github.com/YaLTeR/niri/wiki/Configuration:-Window-Rules#block-out-from) sensitive windows from screencasts
- [Touchpad gestures](https://github.com/YaLTeR/niri/assets/1794388/946a910e-9bec-4cd1-a923-4a9421707515)
- Configurable layout: gaps, borders, struts, window sizes
- Live-reloading config
@@ -133,11 +134,8 @@ In particular, it supports file choosers and monitor screencasting (e.g. to [OBS
## Configuration
-Niri will load configuration from `$XDG_CONFIG_HOME/.config/niri/config.kdl` or `~/.config/niri/config.kdl`.
-If this fails, it will load [the default configuration file](resources/default-config.kdl).
-Please use the default configuration file as the starting point for your custom configuration.
-
-Niri will live-reload most of the configuration settings, like key binds or gaps or output modes, as you change the config file.
+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