From 81cb9a53426376750dd8dc183ece5cb9d39d7f8f Mon Sep 17 00:00:00 2001 From: thomasschafer Date: Wed, 11 Dec 2024 11:43:04 +0000 Subject: [PATCH] Add Helix config section to readme --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 975e4ef..55fbe95 100644 --- a/README.md +++ b/README.md @@ -84,9 +84,24 @@ cd scooter cargo install --path . --locked ``` -## Neovim configuration +## Editor configuration -If you use Neovim you may want to set up Scooter to run as a floating terminal window, allowing you to use it without leaving your editor. To do so, install Toggleterm as per the instructions [here](https://github.com/akinsho/toggleterm.nvim?tab=readme-ov-file#installation), and then add the following Lua configuration, which opens up Scooter with `s`: +Below are a couple of ways to configure Scooter to run in a floating window, without leaving your editor. + +### Helix + +If you are using Helix in Tmux, you can add a keymap like the following: + +```toml +[keys.select.ret] +s = ":sh tmux popup -xC -yC -w90% -h90% -E scooter" +``` + +The above uses `` but this can of course be changed. + +### Neovim + +Install Toggleterm as per the instructions [here](https://github.com/akinsho/toggleterm.nvim?tab=readme-ov-file#installation), and then add the following Lua configuration, which opens up Scooter with `s`: ```lua local Terminal = require("toggleterm.terminal").Terminal