From 87c68de419b6cb44c4d6db347a4759739ff5b736 Mon Sep 17 00:00:00 2001 From: Myzel394 <50424412+Myzel394@users.noreply.github.com> Date: Sun, 20 Oct 2024 15:47:53 +0200 Subject: [PATCH] docs: Add installation instructions --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 43 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8c24ad5..c6debff 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,52 @@ You are welcome to request any config file, as far as it's fairly well known. ## Installation +### VS Code Extension + +[Install the extension from the marketplace](https://marketplace.visualstudio.com/items?itemName=myzel394.config-lsp) + +Alternatively, you can also manually install the extension: + +1. Download the latest extension version from the [release page](https://github.com/Myzel394/config-lsp/releases) - You can find the extension under the "assets" section. The filename ends with `.vsix` +2. Open VS Code +3. Open the extensions sidebar +4. In the top bar, click on the three dots and select "Install from VSIX..." +5. Select the just downloaded `.vsix` file +6. You may need to restart VS Code +7. Enjoy! + +### Manual installation + +To use `config-lsp` in any other editor, you'll need to install it manually. +Don't worry, it's easy! + +#### Installing the latest Binary + +##### Brew + +```sh +brew install myzel394/formulae/config-lsp +``` + +##### Manual Binary + 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. +##### Compiling -### Neovim installation +You can either compile the binary using go: + +```sh +go build -o config-lsp +``` + +or build it using Nix: + +```sh +nix flake build +``` + +#### 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): @@ -57,14 +98,6 @@ 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).