andr3/zls
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update information about installing

Browse Source
This commit is contained in:
Luke I. Wilson 2020-11-22 14:09:31 -06:00 committed by GitHub
parent bf4f653bf9
commit 353c580090
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -21,7 +21,13 @@ Zig Language Server, or `zls`, is a language server for Zig. The Zig wiki states
## Installation ## 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 ```bash
git clone --recurse-submodules https://github.com/zigtools/zls git clone --recurse-submodules https://github.com/zigtools/zls
@ -31,16 +37,17 @@ zig build -Drelease-fast
# To configure zls: # To configure zls:
zig build config zig build config
``` ```
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
<!-- When updating this table, be sure to copy changes to the Wiki page about building from source. -->
<!-- If this table grows too large, then delete this one and move it all over to the Wiki page about building from source. -->
| Option | Type | Default Value | What it Does | | 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.| | `-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 ### Configuration Options
You can configure zls by providing a zls.json file. You can configure zls by providing a zls.json file.