mirror of
https://github.com/Myzel394/config-lsp.git
synced 2025-06-18 15:05:28 +02:00
feat(docs): Add installation instruction
This commit is contained in:
parent
073cc00453
commit
634aff5993
39
README.md
39
README.md
@ -26,6 +26,45 @@ I will first focus on widely used and well known config files.
|
||||
|
||||
You are welcome to request any config file, as far as it's fairly well known.
|
||||
|
||||
## Installation
|
||||
|
||||
Download the latest binary from the [releases page](https://github.com/Myzel394/config-lsp/releases) and put it in your PATH.
|
||||
|
||||
Follow the instructions for your editor below.
|
||||
|
||||
### Neovim installation
|
||||
|
||||
Using [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) you can add `config-lsp` by adding the following to your `lsp.lua` (filename might differ):
|
||||
|
||||
```lua
|
||||
if not configs.config_lsp then
|
||||
configs.config_lsp = {
|
||||
default_config = {
|
||||
cmd = { 'config-lsp' },
|
||||
filetypes = {
|
||||
"sshconfig",
|
||||
"sshdconfig",
|
||||
"fstab",
|
||||
"aliases",
|
||||
-- Matches wireguard configs and /etc/hosts
|
||||
"conf",
|
||||
},
|
||||
root_dir = vim.loop.cwd,
|
||||
},
|
||||
}
|
||||
end
|
||||
|
||||
lspconfig.config_lsp.setup {}
|
||||
`````
|
||||
|
||||
### VS Code installation
|
||||
|
||||
The VS Code extension is currently in development. An official extension will be released soon.
|
||||
|
||||
However, at the moment you can also compile the extension yourself and run it in development mode.
|
||||
|
||||
**Do not create an extension and publish it yourself. Contribute to the official extension instead.**
|
||||
|
||||
## Supporting config-lsp
|
||||
|
||||
You can either contribute to the project, [see CONTRIBUTING.md](CONTRIBUTING.md), or you can sponsor me via [GitHub Sponsors](https://github.com/sponsors/Myzel394) or via [crypto currencies](https://github.com/Myzel394/contact-me?tab=readme-ov-file#donations).
|
||||
|
Loading…
x
Reference in New Issue
Block a user