From 273d3734e327425176142ff36c62044cd18ad19e Mon Sep 17 00:00:00 2001 From: Oscar Wallberg Date: Fri, 9 Aug 2024 01:39:33 +0200 Subject: [PATCH] docs(README): improve readability --- README.md | 66 +++++++++++++++++-------------------------------------- 1 file changed, 20 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index e766efd..7d0b603 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,32 @@ My Neovim config. -# System Requirements -Only supports Linux, macOS and other BSD variants. -These are the general requirements to get started: +## System Requirements +Only supports Linux, macOS and other BSD variants. Requires latest git master of neovim. -- Neovim (latest git master) -- git -- tar -- curl or wget -- unzip -- gzip +Below is a list of dependencies and the respective plugins that require it. -## Optional +| Dependency | Plugins | +| ------------ | ----------------------------------------- | +| git | lazy, mason | +| C compiler | treesitter, LuaSnip, telescope-fzf-native | +| make | LuaSnip, telescope-fzf-native | +| curl or wget | mason | +| unzip | mason | +| GNU tar | mason | +| gzip | mason | -The following are optional but provides additional features: - -- make -- gcc and g++ -- npm -- python3 with venv -- java runtime -- shellcheck -- php -- composer -- golang - -The sections below describes this in more detail. - -### Treesitter -Some parsers require tools for compilation, like `gcc` and/or `g++`. There are -far too many parsers for me to list (and keep track of) all their dependencies -here, but `gcc` and `g++` should cover a lot of them. You will generally -encounter an error that describes if something is missing upon opening specific -filetypes, because treesitter is configured to automatically install parsers -when needed. - -### Language servers +## Language servers Language servers are installed automatically to the nvim data directory (`:echo stdpath('data') .. '/mason'`) upon entering a buffer of related -filetype. Automatic installation can be turned off, see the end of this section -for instructions. +filetype. Automatic installation can be turned off, see the end of this section. -Some language servers have additional dependencies. If they are missing a -warning will show up and the server will be disabled. Each dependency is listed -in the server configuration under `lua/lsp/config/.lua`. +Language server configurations are located at `lua/lsp/config/.lua`. They can be disabled +by setting `enable = false`. -If you don't need some specific language server, you can disable them in -`lua/lsp/config/.lua`. +Some have additional dependencies. If any are missing, a warning is emitted and the server will +be disabled automatically. Each dependency is listed in the configuration file. -To disable automatic installation of a selected language server, remove or -comment out the `mason` part of the configuration at `lua/lsp/config/.lua`. +To disable automatic installation, remove the `mason` configuration. -### Clipboard -see `:checkhealth` and `:h clipboard`. - -# License +## License BSD-3-Clause, see [LICENSE](LICENSE) for more information.