aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorzbirenbaum <zacharyobirenbaum@gmail.com>2022-04-25 04:39:51 -0400
committerzbirenbaum <zacharyobirenbaum@gmail.com>2022-04-25 04:44:34 -0400
commit8c435a2cf81365d1fcc8628133f83d482a333c82 (patch)
tree803000aa03d0ea57318c48906e032cc880cb9969 /README.md
parentadd enable flag for new mappings (diff)
finish shortcut method and update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 25 insertions, 7 deletions
diff --git a/README.md b/README.md
index c1188f8..dd06473 100644
--- a/README.md
+++ b/README.md
@@ -45,11 +45,21 @@ require("nvterm").setup({
float = "<A-i>",
horizontal = "<A-h>",
vertical = "<A-v>",
- }
- }
+ },
+ new = {
+ horizontal = "<C-h>",
+ vertical = "<C-v>",
+ },
+ },
+ enable_new_mappings = false,
})
```
-A shortcut is available for setting options of the different terminal types:
+
+```
+By default, the mappings for creating a new terminal rather than toggling the current one are disabled.
+If `enable_new_mappings` is set to true, `new` will be set to any mappings passed in the configuration table under `new` or the defaults.
+```
+A shortcut is available for setting options of the different terminal types and mappings:
```lua
require("nvterm").setup({
float = {
@@ -62,6 +72,11 @@ require("nvterm").setup({
},
horizontal = { location = "rightbelow", split_ratio = .3, },
vertical = { location = "rightbelow", split_ratio = .5 },
+ mappings{
+ toggle {
+ horizontal = "<A-s>"
+ }
+ }
})
```
@@ -81,8 +96,11 @@ require("nvterm").setup({
},
horizontal = { location = "rightbelow", split_ratio = .3, },
vertical = { location = "rightbelow", split_ratio = .5 },
- }
- }
+ },
+ },
+ toggle {
+ horizontal = "<A-s>",
+ },
})
```
@@ -101,8 +119,8 @@ local ft_cmds = {
}
local mappings = {
{ 'n', '<C-l>', function () terminal.send(ft_cmds[vim.bo.filetype]) end },
- { 'n', '<Leader>s', function () terminal.new_or_toggle('horizontal') end },
- { 'n', '<Leader>v', function () terminal.new_or_toggle('vertical') end },
+ { 'n', '<Leader>s', function () terminal.toggle('horizontal') end },
+ { 'n', '<Leader>v', function () terminal.toggle('vertical') end },
}
local opts = { noremap = true, silent = true }
for _, mapping in ipairs(mappings) do