From e7d36d8904b26084f0dee63fcdfbfc7162d35658 Mon Sep 17 00:00:00 2001 From: Oscar Wallberg Date: Mon, 4 Sep 2023 22:24:14 +0200 Subject: [PATCH] Update README --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b860d3..dfadcd9 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,21 @@ These are the requirements to make use of this neovim configuration. Currently o - git - tar -## Language Server dependencies -Some language servers included in this config requires some additional software. Without these installed, you will get a warning and the servers will not be enabled. If you don't need them, and want to get rid of the warning, you may either remove them in `lua/lsp/servers/init.lua` or disable them in `lua/lsp/servers/.lua`. +## Optional + +The following are optional but provides additional features. + +### Language Server dependencies +Some language servers included in this config requires some additional software. Without these installed, you will get a warning and the servers will not be enabled. If you don't need them, and want to get rid of the warning, you may either remove them from `lua/lsp/servers/init.lua` or disable them in `lua/lsp/servers/.lua`. - **bashls**: npm, shellcheck - **diagnosticls**: npm + +### treesitter +The treesitter CLI executable might be needed for installing some parsers. You will encounter an error if you try to install one that requires it and you don't have treesitter CLI utility installed. + +### Clipboard +see `:checkhealth` and `:h clipboard`. + +# License +See the included [LICENSE](LICENSE) file. \ No newline at end of file