falsepattern/ZigBrains
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

docs: Improve quickstart and add icon guide

Browse source
This commit is contained in:
FalsePattern 2023-08-18 12:36:59 +02:00 • committed by FalsePattern
parent cb30860ec6
commit 2d1620f86d
Signed by: falsepattern
GPG key ID: FDF7126A9E124447
1 changed files with 17 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -12,11 +12,26 @@ In addition to the generated sources, you also need to run the `build setup -> n
complain about missing files complain about missing files
# Description # Description
<!-- Plugin description --> <!-- Plugin description -->
Yet another attempt at bringing zig to the IntelliJ world. An LSP-powered language plugin for the Zig Programming Language.
## QUICKSTART ## QUICKSTART
Go to `Settings` -> `Languages & Frameworks` -> `Zig` -> `ZLS path` -> select your `zls` executable 1. Download or compile the ZLS language server, available at https://github.com/zigtools/zls
2. Go to `Settings` -> `Languages & Frameworks` -> `Zig` -> `ZLS path` -> set the path to the `zls` executable you downloaded or compiled
3. Open a .zig file, and wait for the circle in the bottom status bar to turn Green (empty).
See below for an explanation on what the circle means.
## LSP status icon explanation
Red (X symbol):
LSP server is stopped. You either don't have a proper ZLS path set, or you don't have a .zig file open.
Yellow ("refresh arrow" symbol):
LSP server is starting, please be patient.
Green (empty):
LSP server is running.
## Feature tracker: ## Feature tracker: