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

README: describe how to quickly install ZLS

Browse Source 
I have had these commands in my personal docs for a while now because I find them useful when setting up the Zig language server, especially because remembering the right tar options and that `xz` needs to be installed can be difficult to recall. I thought maybe they'd make a good addition to the README.
This commit is contained in:
Stephen Gutekanst 2021-02-21 15:03:55 -07:00 committed by GitHub
parent a886ecddd9
commit 6bffbd034d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -23,6 +23,26 @@ Installation starts with downloading an official release from the [Releases page
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. 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.
### Installing binaries
#### MacOS
You can install the latest release into `$HOME/zls` using e.g.:
```sh
brew install xz
mkdir $HOME/zls && cd $HOME/zls && curl -L https://github.com/zigtools/zls/releases/download/0.1.0/x86_64-macos.tar.xz | tar -xJ --strip-components=1 -C .
```
#### Linux
You can install the latest release into `$HOME/zls` using e.g.:
```
sudo apt install xz-utils
mkdir $HOME/zls && cd $HOME/zls && curl -L https://github.com/zigtools/zls/releases/download/0.1.0/x86_64-linux.tar.xz | tar -xJ --strip-components=1 -C .
```
### From Source ### From Source
Building `zls` is very easy. You will need [a build of Zig master](https://ziglang.org/download/) to build zls. Building `zls` is very easy. You will need [a build of Zig master](https://ziglang.org/download/) to build zls.