snailed
/
taolf
Archived
2
0
Fork 0

update(readme): add installation

This commit is contained in:
Lucas Burns 2022-05-26 18:53:27 -05:00
parent a6f55cea94
commit 38f491f6ba
No known key found for this signature in database
GPG Key ID: C011CBEF6628B679
1 changed files with 29 additions and 1 deletions

View File

@ -5,6 +5,34 @@ It is very similar to [`lf.vim`](https://github.com/ptzz/lf.vim), except for tha
**NOTE**: This plugin uses [`toggleterm.nvim`](https://github.com/akinsho/toggleterm.nvim) and [`plenary.nvim`](https://github.com/nvim-lua/plenary.nvim)
### Installation
```lua
-- Sample configuration is supplied
use(
{
"lmburns/lf.nvim",
config = function()
-- This feature will not work if the plugin is lazy-loaded
vim.g.lf_netrw = 1
require("lf").setup(
{
escape_quit = false,
border = "rounded",
highlights = {FloatBorder = {guifg = require("kimbox.palette").colors.magenta}}
}
)
vim.keymap.set("n", "<C-o>", ":Lf<CR>")
end,
requires = {
"plenary.nvim",
"toggleterm.nvim"
}
}
)
```
### Setup/Configuration
```lua
@ -125,7 +153,7 @@ require("lf").start({ mappings = false })
```
### Replacing Netrw
The only configurable environment variable is `g:lf_netrw`, which can be set to `1` to replace `netrw`
The only configurable environment variable is `g:lf_netrw`, which can be set to `1` or `true` to replace `netrw`
### Key mappings
The mappings that are listed in the `setup` call above are the default bindings.