From 316a2f7699db08ae9ba27826354fdda13458a3b4 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 16 Aug 2025 16:00:14 -0400 Subject: Update docs and setting --- .gitignore | 1 + README.md | 21 +++++++++++++++++---- docs/float-open.png | Bin 0 -> 671930 bytes docs/split-open.png | Bin 0 -> 646050 bytes plugin.tmux | 6 +++--- 5 files changed, 21 insertions(+), 7 deletions(-) create mode 100644 .gitignore create mode 100644 docs/float-open.png create mode 100644 docs/split-open.png diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e43b0f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/README.md b/README.md index 225f661..b17bb88 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,25 @@ Reload tmux and press prefix + I to install. ## Usage -- `C-;` → Toggle a split terminal for the current tmux window -- `C-f` → Toggle a global floating popup terminal +### Toggle Split Terminal + +`C-;` → Toggle a split terminal for the current tmux window + +![Split Pane](./docs/split-open.png) + +### Toggle Floating Terminal + +`C-f` → Toggle a global floating popup terminal + +![Floating Window](./docs/float-open.png) + +### Customization + +If needed, you can override the default keybindings by setting the +`toggle_term_split_key` and `toggle_term_float_key` options. -You can override the default hotkeys if desired: ```tmux -set -g @toggle_term_key 'M-t' +set -g @toggle_term_split_key 'M-t' set -g @toggle_term_float_key 'M-f' ``` diff --git a/docs/float-open.png b/docs/float-open.png new file mode 100644 index 0000000..fda5176 Binary files /dev/null and b/docs/float-open.png differ diff --git a/docs/split-open.png b/docs/split-open.png new file mode 100644 index 0000000..ab74176 Binary files /dev/null and b/docs/split-open.png differ diff --git a/plugin.tmux b/plugin.tmux index 3c81ab5..c5c851b 100644 --- a/plugin.tmux +++ b/plugin.tmux @@ -1,7 +1,7 @@ -if -n "#{==:#{@toggle_term_key},}" \ - set -g @toggle_term_key 'C-;' +if -n "#{==:#{@toggle_term_split_key},}" \ + set -g @toggle_term_split_key 'C-;' if -n "#{==:#{@toggle_term_float_key},}" \ set -g @toggle_term_float_key 'C-f' -bind-key -n "#{@toggle_term_key}" run-shell -b "#{sourcedir}/toggle-term.sh split" +bind-key -n "#{@toggle_term_split_key}" run-shell -b "#{sourcedir}/toggle-term.sh split" bind-key -n "#{@toggle_term_float_key}" run-shell -b "#{sourcedir}/toggle-term.sh float" -- cgit v1.2.3