Merge pull request #109 from codemessiah/patch-1

Update readme: mention the requirement of Zig master
This commit is contained in:
Auguste Rame 2020-06-10 09:24:26 -04:00 committed by GitHub
commit 661413a53a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -21,7 +21,7 @@ Zig Language Server, or `zls`, is a language server for Zig. The Zig wiki states
## Installation ## Installation
Installing `zls` is pretty simple; Installing `zls` is pretty simple. You will need [a build of Zig master](https://ziglang.org/download/) (or >0.6) to build ZLS.
```bash ```bash
git clone --recurse-submodules https://github.com/zigtools/zls git clone --recurse-submodules https://github.com/zigtools/zls
@ -40,8 +40,6 @@ zig build config
Then, you can use the `zls` executable in an editor of your choice that has a Zig language server client! Then, you can use the `zls` executable in an editor of your choice that has a Zig language server client!
*Note: `zls` itself must be built using the master branch of zig currently due to a bug in `std.json` which was [fixed](https://github.com/ziglang/zig/pull/5167) after 0.6.0 was released, as well as various parser changes that have happened since.*
### Configuration Options ### Configuration Options
You can configure zls by providing a zls.json file. You can configure zls by providing a zls.json file.