diff --git a/.assets/wiki/extension-in-vscode.png b/.assets/wiki/extension-in-vscode.png new file mode 100644 index 0000000..9cca02b Binary files /dev/null and b/.assets/wiki/extension-in-vscode.png differ diff --git a/.assets/wiki/path-setting-in-vscode-extension.png b/.assets/wiki/path-setting-in-vscode-extension.png new file mode 100644 index 0000000..c559dbd Binary files /dev/null and b/.assets/wiki/path-setting-in-vscode-extension.png differ diff --git a/README.md b/README.md index 005b4dd..40f21a0 100644 --- a/README.md +++ b/README.md @@ -21,26 +21,31 @@ Zig Language Server, or `zls`, is a language server for Zig. The Zig wiki states ## Installation -Installing `zls` is pretty simple. You will need [a build of Zig master](https://ziglang.org/download/) to build zls. +Installation starts with downloading an official release from the [Releases page](https://github.com/zigtools/zls/releases). + +See [Downloading and Building ZLS](https://github.com/zigtools/zls/wiki/Downloading-and-Building-ZLS) on the Wiki, or the page about [using ZLS with Visual Studio Code](https://github.com/zigtools/zls/wiki/Installing-for-Visual-Studio-Code) for a guide to help get `zls` running in your editor. + +### From Source + +Building `zls` is very easy. You will need [a build of Zig master](https://ziglang.org/download/) to build zls. ```bash git clone --recurse-submodules https://github.com/zigtools/zls cd zls -zig build -Drelease-fast - -# To configure zls: -zig build config +zig build -Drelease-safe +zig build config # Configure ZLS ``` -The `zls` executable will be saved to `zls\zig-cache\bin`. -### Build Options +*For detailed building instructions, see the Wiki page about [Cloning With Git](https://github.com/zigtools/zls/wiki/Downloading-and-Building-ZLS#cloning-with-git).* +#### Build Options + + + | Option | Type | Default Value | What it Does | | --- | --- | --- | --- | | `-Ddata_version` | `string` (master or 0.7.0) | master | The data file version. This selects the files in the `src/data` folder that correspond to the Zig version being served.| -Then, you can use the `zls` executable in an editor of your choice that has a Zig language server client! - ### Configuration Options You can configure zls by providing a zls.json file.