aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 58d8865..2173415 100644
--- a/README.md
+++ b/README.md
@@ -14,3 +14,15 @@ exit it with master+shift+q
```sh
./start.sh
```
+
+## config
+
+config location is `XDG_CONFIG_HOME/wm/config.toml`. On startup, if the wm doesn't find
+a file at that location, it will copy `default_config.toml` there. it's read on startup,
+so to apply changes you can use the restart keybind (`mod+shift+r` by default), any keys
+left out will use the defaults, invalid values are logged and skipped.
+
+binds are in `[binds]` as
+`"<mods>+<key>" = "<action>"`, where `mod` is your configured mod key and an empty action unbinds.
+actions: `spawn <shell command>`, `quit`, `restart`, `kill`, `layout <name>`,
+`masters <+n|-n>`, `ratio <+0.05|-0.05>`, `view <n|all>`, `toggle <n|all>`, `tag <n|all>`.