chore: added license, mentioned keybindings, tmux=false, spelling corrections
This commit is contained in:
parent
d4c08af70d
commit
e57c835d0e
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2022 Lucas Burns
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
15
README.md
15
README.md
|
@ -99,10 +99,10 @@ require('lf').start() -- opens in CWD with either `.setup()` or default options
|
|||
require('lf').start("~/.config", { border = "rounded" }) -- opens in `~/.config` with rounded borders
|
||||
```
|
||||
|
||||
### Highlighting Groups
|
||||
### Highlight Groups
|
||||
The highlight groups that I know for sure work are the ones mentioned above (`Normal`, `NormalFloat`, `FloatBorder`). These are passed to `toggleterm`, and there is a plan in the future to make these `Lf`'s own groups. For now, a one-shot way to change the color of the border of the terminal is the following:
|
||||
|
||||
```
|
||||
```vim
|
||||
:lua require("lf").start({ highlights = { FloatBorder = { guifg = "#819C3B" } } })
|
||||
```
|
||||
|
||||
|
@ -125,6 +125,17 @@ require("lf").start({ mappings = false })
|
|||
### Replacing Netrw
|
||||
The only configurable environment variable is `g:lf_replace_netrw`, which can be set to `1` to replace `netrw`
|
||||
|
||||
### Key mappings
|
||||
The mappings that are listed in the `setup` call above are the default bindings.
|
||||
|
||||
* `<C-t>` = `tabedit`
|
||||
* `<C-x>` = `split`
|
||||
* `<C-v>` = `vsplit`
|
||||
* `<C-o>` = `tab drop`
|
||||
* `<A-u>` = resize the floating window
|
||||
|
||||
A suggested binding to use to open `Lf` is `<C-o>` or `<A-o>`.
|
||||
|
||||
### TODO
|
||||
- [ ] `:LfToggle` command
|
||||
- [x] Find a way for `lf` to hijack keybindings
|
||||
|
|
|
@ -42,7 +42,7 @@ local function init()
|
|||
height = 0.80,
|
||||
width = 0.85,
|
||||
mappings = true,
|
||||
tmux = true,
|
||||
tmux = false,
|
||||
highlights = {},
|
||||
-- Layout configurations
|
||||
layout_mapping = "<A-u>",
|
||||
|
|
Reference in New Issue