Skip to content

Commit f302ba6

Browse files
committed
update README.md
1 parent 7a919dc commit f302ba6

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@
33
[![CI](https://github.com/zigtools/zls/actions/workflows/main.yml/badge.svg)](https://github.com/zigtools/zls/actions/workflows/main.yml)
44
[![codecov](https://codecov.io/github/zigtools/zls/graph/badge.svg?token=WE18MPF00W)](https://codecov.io/github/zigtools/zls)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6-
7-
**Need support? Wanna help out? Join our [Discord server](https://discord.gg/5m5U3qpUhk)!**
6+
[![Discord](https://discord.com/api/guilds/997174129532866701/widget.png?style=shield)](https://discord.gg/5m5U3qpUhk)
87

98
ZLS is a non-official implementation of the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) for [Zig](https://ziglang.org/) in Zig. It provides developers with IDE [features](#features) in their editor.
109

1110
## Installation
1211

13-
### See the [Installation Guide](https://zigtools.org/zls/install/) for editor and binary installation instructions.
12+
The complete installation guide is available on the [Zigtools website](https://zigtools.org/zls/install/). It covers editor setup, prebuilt binaries and additional documentation.
1413

15-
### From Source
14+
### Build From Source
1615

1716
Building ZLS requires [a build of Zig master](https://ziglang.org/download/).
1817

@@ -22,6 +21,8 @@ cd zls
2221
zig build -Doptimize=ReleaseSafe
2322
```
2423

24+
When upgrading Zig, make sure to update ZLS too keep them in sync.
25+
2526
## Features
2627

2728
ZLS supports most language features, including simple type function support, using namespace, payload capture type resolution, custom packages, cImport and others. Support for comptime and semantic analysis is Work-in-Progress.

0 commit comments

Comments
 (0)