From e57c835d0e4c530bda601f1511c4ba6479db8224 Mon Sep 17 00:00:00 2001 From: Lucas Burns Date: Sat, 16 Apr 2022 22:20:45 -0500 Subject: [PATCH] chore: added license, mentioned keybindings, tmux=false, spelling corrections --- LICENSE | 21 +++++++++++++++++++++ README.md | 15 +++++++++++++-- lua/lf/config.lua | 2 +- 3 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9a4593c --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md index d1eb7b6..4e2aed2 100644 --- a/README.md +++ b/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. + +* `` = `tabedit` +* `` = `split` +* `` = `vsplit` +* `` = `tab drop` +* `` = resize the floating window + +A suggested binding to use to open `Lf` is `` or ``. + ### TODO - [ ] `:LfToggle` command - [x] Find a way for `lf` to hijack keybindings diff --git a/lua/lf/config.lua b/lua/lf/config.lua index 9e73576..0aa7cda 100644 --- a/lua/lf/config.lua +++ b/lua/lf/config.lua @@ -42,7 +42,7 @@ local function init() height = 0.80, width = 0.85, mappings = true, - tmux = true, + tmux = false, highlights = {}, -- Layout configurations layout_mapping = "",