diff --git a/README.md b/README.md index 3438e531..acc31f36 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,14 @@ [Join us on matrix](https://matrix.to/#/#nvim-tree:matrix.org) +## Requirements + +[neovim >=0.7.0](https://github.com/neovim/neovim/wiki/Installing-Neovim) + +[nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) is optional and used to display file icons. It requires a [patched font](https://www.nerdfonts.com/) ## Install -This plugin requires [neovim >=0.7.0](https://github.com/neovim/neovim/wiki/Installing-Neovim). - Install with [vim-plug](https://github.com/junegunn/vim-plug): ```vim @@ -110,6 +113,7 @@ nvim-tree comes with number of mappings; for default mappings please see [:help * If you `:set nosplitright`, the files will open on the left side of the tree, placing the tree window in the right side of the file you opened. * You can automatically close the tab/vim when nvim-tree is the last window in the tab: . WARNING: this can catastrophically fail: . This will not be added to nvim-tree and the team will not provide support / assistance with this, due to complexities in vim event timings and side-effects. * Hide the `.git` folder: `filters = { custom = { "^.git$" } }`. See [:help nvim-tree.filters.custom](doc/nvim-tree-lua.txt). +* To disable the display of icons see [:help nvim-tree.renderer.icons.show](https://neovim.io/doc/user/lua.html) ## Troubleshooting diff --git a/doc/nvim-tree-lua.txt b/doc/nvim-tree-lua.txt index c09d842f..03b947e0 100644 --- a/doc/nvim-tree-lua.txt +++ b/doc/nvim-tree-lua.txt @@ -30,11 +30,15 @@ Features File Icons - See https://github.com/kyazdani42/nvim-web-devicons - Requires a patched font. + https://github.com/kyazdani42/nvim-web-devicons is optional and used to display file icons. It requires a patched font: https://www.nerdfonts.com +  should look like an open folder. - Syntax highlighting uses g:terminal_color_ from colorschemes, fallbacks to + To disable the display of icons see |renderer.icons.show| + +Colours + + Syntax highlighting uses g:terminal_color_ from colorschemes, falls back to ugly colors otherwise. Git Integration