From e0d0502539a558b547df7206f621034605021463 Mon Sep 17 00:00:00 2001 From: a-kenji Date: Sat, 13 Mar 2021 12:48:27 +0100 Subject: Add config to README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index f9bc9fe04..e1986d9c7 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3 From d3a72a27df5021d35600071b96edd8c0f79e9105 Mon Sep 17 00:00:00 2001 From: a-kenji Date: Tue, 16 Mar 2021 21:14:10 +0100 Subject: Add key events documentation Add key events documentation from termion to the README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e1986d9c7..eea400600 100644 --- a/README.md +++ b/README.md @@ -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: ``` -- cgit v1.2.3 From 68737f78ac247814f2ad79e27d4f0da7c960b4a9 Mon Sep 17 00:00:00 2001 From: a-kenji Date: Fri, 26 Mar 2021 22:12:01 +0100 Subject: Config: Fix README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index eea400600..203de8ccf 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ An example file can be found under `example/config.yaml`. 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]`. +`cargo run -- config [FILE]` or `zellij config [FILE]`. The structure is as follows: ``` -- cgit v1.2.3