From 4bb71c272e3150c2ca27d0e7e193eb7dd0efc243 Mon Sep 17 00:00:00 2001 From: BZ Date: Fri, 26 Jun 2020 18:35:48 +0200 Subject: [PATCH] add gif to readme --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0536e91..6ce5601 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,16 @@ AwesomeWM - Vim - Tmux Navigator ================== -This plugin lets you navigate seamlessly between system windows, vim splits and tmux panes using a consisent set of hotkeys. -Based on [christoomey/vim-tmux-navigator](https://github.com/christoomey/vim-tmux-navigator) and [fogine/vim-i3wm-tmux-navigator](https://github.com/fogine/vim-i3wm-tmux-navigator). +

+ +

+ +`awesomewm-vim-tmux-navigator` lets you navigate seamlessly between system windows, vim splits and tmux panes using a consisent set of hotkeys. +It's based on [christoomey/vim-tmux-navigator](https://github.com/christoomey/vim-tmux-navigator) and [fogine/vim-i3wm-tmux-navigator](https://github.com/fogine/vim-i3wm-tmux-navigator). + +How does it work +------------ +The plugin detects the focused application and simulates the correct keypresses so you can forget whether you are using tmux, vim, or another application. Installation ------------ @@ -10,12 +18,11 @@ Installation ### AwesomeWM Clone the repo. ``` -cd ~/.config/awesome -git clone https://github.com/intrntbrn/awesomewm-vim-tmux-navigator +git clone https://github.com/intrntbrn/awesomewm-vim-tmux-navigator ~/.config/awesome/awesomewm-vim-tmux-navigator ``` -This path is hardcoded in some configuration files. +It's not recommended to change the path since it's hardcoded in some configuration files. -Add your preferred navigation keybinds to `rc.lua` (e.g. Mod4+arrow or Mod4+hjkl) +Add your preferred navigation (focus) keybinds to `rc.lua` (e.g. Mod4+arrow or Mod4+hjkl) ``` require("awesomewm-vim-tmux-navigator"){