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

docs: update readme

Browse source
This commit is contained in:
FalsePattern 2025-04-11 17:08:13 +02:00
parent 2d0ad8be44
commit 520167414a
Signed by: falsepattern
GPG key ID: E930CDEC50C50E23
1 changed files with 2 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -71,11 +71,7 @@ excellent example on how to write debugger support that doesn't depend on CLion.
<!-- Plugin description -->
Adds support for the Zig Language, utilizing the ZLS language server for advanced coding assistance.
## Quick setup guide for Zig and ZLS
1. Download the latest version of Zig from https://ziglang.org/download
2. Download and compile the ZLS language server, available at https://github.com/zigtools/zls
3. Go to `Settings` -> `Languages & Frameworks` -> `Zig`, and point the `Toolchain Location` and `ZLS path` to the correct places
Before you can properly use the plugin, you need to select or download the Zig toolchain and language server in `Settings` -> `Languages & Frameworks` -> `Zig`.
## Debugging
@ -89,6 +85,7 @@ Debugging Zig code is supported in any native debugging capable IDE. The followi
- RustRover (including the non-commercial free version too)
- GoLand
- PyCharm Professional
- Android Studio
Additionally, in CLion, the plugin uses the C++ Toolchains for sourcing the debugger (this can be toggled off in the settings).