aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2025-08-16 16:00:14 -0400
committerEugene Triguba <hello@eugenetriguba.com>2025-08-16 16:00:14 -0400
commit316a2f7699db08ae9ba27826354fdda13458a3b4 (patch)
tree5b4a1ec54b2dab60e0bb65a3b4eae5571ac24c43
parentAdd bc to build (diff)
downloadtmux-toggle-term-316a2f7699db08ae9ba27826354fdda13458a3b4.zip
Update docs and setting
-rw-r--r--.gitignore1
-rw-r--r--README.md21
-rw-r--r--docs/float-open.pngbin0 -> 671930 bytes
-rw-r--r--docs/split-open.pngbin0 -> 646050 bytes
-rw-r--r--plugin.tmux6
5 files changed, 21 insertions, 7 deletions
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
--- /dev/null
+++ b/docs/float-open.png
Binary files differ
diff --git a/docs/split-open.png b/docs/split-open.png
new file mode 100644
index 0000000..ab74176
--- /dev/null
+++ b/docs/split-open.png
Binary files 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"