aboutsummaryrefslogtreecommitdiff
path: root/find-file/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'find-file/README.md')
-rw-r--r--find-file/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/find-file/README.md b/find-file/README.md
new file mode 100644
index 0000000..cfee229
--- /dev/null
+++ b/find-file/README.md
@@ -0,0 +1,18 @@
+# `find-file.sh`
+`find-file` Launches a broot menu for opening files.
+- `C-s` opens the file in a new split. It will automatically choose hsplit or vsplit based on pane size
+- `C-w` opens the file in a new window
+
+## Setup
+If you haven't already, clone the repo to a know location, such as `~/.config/tmux/m`.
+```sh
+cd ~/.config/tmux
+git clone https://github.com/bluedragon1221/tmux-minibuffer m
+```
+
+In `file.toml`, replace the parts that refer to `split.sh` with the correct path to split.sh.
+
+Now you can add a keybinding to launch `find-file`:
+```sh
+bind-key -n C-f run-shell "~/.config/tmux/m/minibuffer.sh '~/.config/tmux/m/find-file/launch-find-file.sh'"
+```