docs(README): improve readability
This commit is contained in:
@@ -1,58 +1,32 @@
|
|||||||
My Neovim config.
|
My Neovim config.
|
||||||
|
|
||||||
# System Requirements
|
## System Requirements
|
||||||
Only supports Linux, macOS and other BSD variants.
|
Only supports Linux, macOS and other BSD variants. Requires latest git master of neovim.
|
||||||
These are the general requirements to get started:
|
|
||||||
|
|
||||||
- Neovim (latest git master)
|
Below is a list of dependencies and the respective plugins that require it.
|
||||||
- git
|
|
||||||
- tar
|
|
||||||
- curl or wget
|
|
||||||
- unzip
|
|
||||||
- gzip
|
|
||||||
|
|
||||||
## 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:
|
## Language servers
|
||||||
|
|
||||||
- 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 are installed automatically to the nvim data directory
|
Language servers are installed automatically to the nvim data directory
|
||||||
(`:echo stdpath('data') .. '/mason'`) upon entering a buffer of related
|
(`:echo stdpath('data') .. '/mason'`) upon entering a buffer of related
|
||||||
filetype. Automatic installation can be turned off, see the end of this section
|
filetype. Automatic installation can be turned off, see the end of this section.
|
||||||
for instructions.
|
|
||||||
|
|
||||||
Some language servers have additional dependencies. If they are missing a
|
Language server configurations are located at `lua/lsp/config/<server>.lua`. They can be disabled
|
||||||
warning will show up and the server will be disabled. Each dependency is listed
|
by setting `enable = false`.
|
||||||
in the server configuration under `lua/lsp/config/<server>.lua`.
|
|
||||||
|
|
||||||
If you don't need some specific language server, you can disable them in
|
Some have additional dependencies. If any are missing, a warning is emitted and the server will
|
||||||
`lua/lsp/config/<server>.lua`.
|
be disabled automatically. Each dependency is listed in the configuration file.
|
||||||
|
|
||||||
To disable automatic installation of a selected language server, remove or
|
To disable automatic installation, remove the `mason` configuration.
|
||||||
comment out the `mason` part of the configuration at `lua/lsp/config/<server>.lua`.
|
|
||||||
|
|
||||||
### Clipboard
|
## License
|
||||||
see `:checkhealth` and `:h clipboard`.
|
|
||||||
|
|
||||||
# License
|
|
||||||
BSD-3-Clause, see [LICENSE](LICENSE) for more information.
|
BSD-3-Clause, see [LICENSE](LICENSE) for more information.
|
||||||
|
|||||||
Reference in New Issue
Block a user