From 3d5da40ff64d05300cca1748d598ff79bde348b0 Mon Sep 17 00:00:00 2001 From: Mike Smith <10135646+mikesmithgh@users.noreply.github.com> Date: Sat, 4 Nov 2023 10:36:59 -0400 Subject: [PATCH] chore: formatting --- README.md | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index ea476038..5202648a 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,7 @@ Navigate your Kitty scrollback buffer to quickly search, copy, and execute comma > v2.0.0 has breaking changes and requires steps to properly migrate from v1.X.X. > > You can ignore this section if you have not previously installed any version of kitty-scrollback.nvim - - + 
Migration Steps @@ -40,28 +39,28 @@ Navigate your Kitty scrollback buffer to quickly search, copy, and execute comma - - If you are using the lazy.nvim or packer.nvim package manager, then - add the custom `User` event `KittyScrollbackLaunch` as a trigger for lazy loading. See [Installation](#-installation) for additional details. + - If you are using the lazy.nvim or packer.nvim package manager, then + add the custom `User` event `KittyScrollbackLaunch` as a trigger for lazy loading. See [Installation](#-installation) for additional details. ```lua event = { 'User KittyScrollbackLaunch' } ``` - - Regenerate default Kitten mappings and add to `kitty.conf` + - Regenerate default Kitten mappings and add to `kitty.conf` ```sh nvim --headless +'KittyScrollbackGenerateKittens' +'set nonumber' +'set norelativenumber' +'%print' +'quit!' 2>&1 ``` - - Remove previous kitty-scrollback.nvim Kitten mappings in `kitty.conf` + - Remove previous kitty-scrollback.nvim Kitten mappings in `kitty.conf` - - The default mapping keys changed from `ctrl+shift` to `kitty_mod`. The default values for `kitty_mod` in Kitty is `ctrl+shift`. - - If you are using the default value for `kitty_mod` of `ctrl+shift`, then no change is needed. - - If you are using a different value for `kitty_mod`, then you should correct any potential mapping conflicts that may occur - now that `kitty-scrollback.nvim` is using `kitty_mod`. + - The default mapping keys changed from `ctrl+shift` to `kitty_mod`. The default values for `kitty_mod` in Kitty is `ctrl+shift`. + - If you are using the default value for `kitty_mod` of `ctrl+shift`, then no change is needed. + - If you are using a different value for `kitty_mod`, then you should correct any potential mapping conflicts that may occur + now that `kitty-scrollback.nvim` is using `kitty_mod`. - - Migrate any customized configurations to the new format - - When you define your kitty-scrollback.nvim Kitten configuration, do not use `--config-file` `yourconfigfile.lua`. Instead, - move the contents of `yourconfigfile.lua` to an entry in the configuration passed to the kitty-scrollback.nvim setup function. + - Migrate any customized configurations to the new format + - When you define your kitty-scrollback.nvim Kitten configuration, do not use `--config-file` `yourconfigfile.lua`. Instead, + move the contents of `yourconfigfile.lua` to an entry in the configuration passed to the kitty-scrollback.nvim setup function. ```lua require('kitty-scrollback').setup({ @@ -71,8 +70,8 @@ end, }) ``` - Update your Kitten to use the name of the configuration defined in the setup function. In this example, - `--config-file yourconfigfile.lua` changes to `--config yourconfig` + Update your Kitten to use the name of the configuration defined in the setup function. In this example, + `--config-file yourconfigfile.lua` changes to `--config yourconfig`
Real example @@ -81,8 +80,8 @@ end, > The configuration to view the last command output now references a builtin configuration instead of a file. The > new configuration can be viewed by running `:KittyScrollbackGenerateKittens`. - - Old configuration - - The Kitten defined in `kitty.conf` references the configuration file `get_text_last_cmd_output.lua` + - Old configuration + - The Kitten defined in `kitty.conf` references the configuration file `get_text_last_cmd_output.lua` ```kitty # Browse output of the last shell command in nvim @@ -104,8 +103,8 @@ end return M ``` - - New configuration - - The Kitten defined in `kitty.conf` references the builtin configuration name `ksb_builtin_last_cmd_output` + - New configuration + - The Kitten defined in `kitty.conf` references the builtin configuration name `ksb_builtin_last_cmd_output` ```kitty # Browse output of the last shell command in nvim