]> git.r.bdr.sh - rbdr/oleoboard.nvim/blame_incremental - README.md
Update README
[rbdr/oleoboard.nvim] / README.md
... / ...
CommitLineData
1# oleoboard.nvim
2
3A tool to use [oil][oil] panes as a kanban-like board.
4
5When summoned it will load the directories in the current directory as columns.
6It depends on oil so it assumes that these are editable. You can then move
7files from one board to another as if you were moving tasks in a kanban board.
8
9## Installation
10
11### lazy.nvim
12
13```lua
14require('lazy').setup({
15 {
16 'https://git.sr.ht/~rbdr/oleoboard.nvim',
17 dependencies = {
18 'stevearc/oil.nvim'
19 }
20 }
21})
22```
23
24By default, oleo-board adds keybinds that might not suit your style or conflict
25with other plugins. You can disable them with the `default_keybinds` option.
26
27```lua
28require('lazy').setup({
29 {
30 'https://git.sr.ht/~rbdr/oleoboard.nvim',
31 dependencies = {
32 'stevearc/oil.nvim'
33 },
34 opts = {
35 default_keybinds = false
36 }
37})
38```
39
40## Default Keybinds
41
42- `<leader>bb`, `:OleoBoardToggle`, Opens and Closes the kanban board
43- `<leader>bl`, `:OleoBoardMoveEntryRight`, Moves the current entry to the right
44- `<leader>bL`, `:OleoBoardMoveColumnRight`, Moves the current column to the right
45- `<leader>bh`, `:OleoBoardMoveEntryLeft`, Moves the current entry to the left
46- `<leader>bH`, `:OleoBoardMoveColumnLeft`, Moves the current column to the left
47
48[oil]: https://github.com/stevearc/oil.nvim