diff options
author | a-kenji <aks.kenji@protonmail.com> | 2021-03-13 12:48:27 +0100 |
---|---|---|
committer | a-kenji <aks.kenji@protonmail.com> | 2021-03-13 12:48:27 +0100 |
commit | e0d0502539a558b547df7206f621034605021463 (patch) | |
tree | 015a1ff5e5cba96da3916def121a5d7a6363848d /README.md | |
parent | 9c0762fc53b567a34d234b2f152e49add895a620 (diff) |
Add config to README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 36 |
1 files changed, 36 insertions, 0 deletions
@@ -36,6 +36,42 @@ Zellij was initially called "Mosaic". The status bar on the bottom should guide you through the possible keyboard shortcuts in the app. +# Configuration +It is possible to configure keyboard shortcuts and their actions in a yaml file. +An example file can be found under `example/config.yaml`. + +To pass a config file to zellij run it either with: +`cargo run -- --config [FILE]` or `zellij --config [FILE]`. + +The structure is as follows: +``` +keybinds: + normal: + - action: [] + key: [] +``` +`normal` is one of the `modes` zellij can be in. +It is possible to bind a sequence of actions to numerous keys at the same time. + + +For example: +``` +keybinds: + normal: + - action: [ NewTab, GoToTab: 1,] + key: [ Char: 'c',] +``` +Will create a new tab and then switch to tab number 1 on pressing the +`c` key. +Whereas: +``` +keybinds: + normal: + - action: [ NewTab,] + key: [ Char: 'c', Char: 'd',] +``` +Will create a new tab on pressing either the `c` or the `d` key. + # What is the current status of the project? Zellij is in the last stages of being VT compatible. As much as modern terminals are. |