From bb1796a1ac304b680001ad3c39b518b7552855ee Mon Sep 17 00:00:00 2001 From: Oscar Wallberg Date: Mon, 4 Sep 2023 15:27:52 +0200 Subject: [PATCH] Update README --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 30404ce..4b860d3 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -TODO \ No newline at end of file +# System Reqiurements +These are the requirements to make use of this neovim configuration. Currently only supports GNU/Linux. + +*Note: You may try using windows, but last time I checked there was a problem with the completion engine (nvim-cmp) that makes it impossible to traverse the drop-down list.* + +- curl or wget +- unzip +- gzip +- 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`. + +- **bashls**: npm, shellcheck +- **diagnosticls**: npm