Skip to content

Commit 6486c9e

Browse files
committed
useful readme
1 parent 45bc08f commit 6486c9e

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
11
# terminal-send
22

3-
A minimalist plugin with the nvim terminal at its core to interact with CLIs of programming languages like `R` and `Python`.
3+
A minimalist plugin to interact with CLIs of programming languages like `R` and `Python`.
44

55
## Usage
66

7-
`<leader>ts+motion`
7+
This package aims to integrate with the usual vim workflow.
8+
The basic setup is to open, e.g., an `R` script and a nvim terminal running `R` in split view.
9+
Now you can send arbitrary text from the script to the terminal with `<leader>ts` and a *motion*.
10+
11+
Additional shortcuts are
12+
13+
* `<leader>tf` for focusing a terminal, e.g., I you use several at once.
14+
* `<leader>tr` for re-sending the last code selection.
815

916
## Installation
1017

1118
Install using your favorite package manager, e.g. [Lazy](https://github.com/folke/lazy.nvim):
1219

1320
```lua
14-
-- install package
1521
require('lazy').setup({
1622
'max607/nvim-terminal-send',
1723
})
1824
```
1925

2026
## Helpful shortcuts
2127

28+
Here are some some shortcuts I would recommend for ease of use.
29+
2230
```
2331
-- open splits on the right and below
2432
vim.opt.splitright = true

0 commit comments

Comments
 (0)