From 6bffbd034dc061fada49785632947cc16ee66901 Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Sun, 21 Feb 2021 15:03:55 -0700 Subject: [PATCH] README: describe how to quickly install ZLS 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. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index dfbf335..eed182d 100644 --- a/README.md +++ b/README.md @@ -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. +### 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 Building `zls` is very easy. You will need [a build of Zig master](https://ziglang.org/download/) to build zls.