diff options
author | a-kenji <aks.kenji@protonmail.com> | 2021-03-16 21:14:10 +0100 |
---|---|---|
committer | a-kenji <aks.kenji@protonmail.com> | 2021-03-16 21:14:10 +0100 |
commit | d3a72a27df5021d35600071b96edd8c0f79e9105 (patch) | |
tree | 76605f178606bbc2c4782c822164f94f13d6cbcb /README.md | |
parent | 2ce034a66acb09a826b124f9d83e57f611ff9aed (diff) |
Add key events documentation
Add key events documentation from termion to the README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 6 |
1 files changed, 4 insertions, 2 deletions
@@ -40,7 +40,9 @@ The status bar on the bottom should guide you through the possible keyboard shor 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: +Zellij will look for a file `/zellij/config.yaml` in the default configuration location of your os. + +To pass a config file directly to zellij run it either with: `cargo run -- --config [FILE]` or `zellij --config [FILE]`. The structure is as follows: @@ -52,7 +54,7 @@ keybinds: ``` `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. - +Here a reference to the [Key](https://docs.rs/termion/1.5.6/termion/event/enum.Key.html) format that is used. For example: ``` |