In the readme.md add a description how to install VHDL_LS for Neovim:
Use in Neovim
Neovim provides an LSP client to the VHDL_LS language server. Install the vhdl_ls
binary e.g. via Cargo. The binary must be on the path and executable (if you
can run "vhdl_ls -h" in the terminal then you're good). Put the "vhdl_libraries"
directory into the parent directory of the vhdl_ls binary.
In your Neovim config.lua add the following:
function STARTVHDLLS()
vim.lsp.start({
name = 'vhdl_ls',
cmd = {'vhdl_ls'},
})
end
vim.api.nvim_set_keymap('n', '<F5>', ':lua STARTVHDLLS()<CR>', { noremap = true, silent = true })
This is just one example, there are many ways to run language servers. Anyway
when you are inside a buffer you can now hit F5 to start VHDL_LS. Autostart is
also possible. For more info, have a look at the Neovim LSP documentation.