From 302a18c32d2db46ab90f040f0794bd5142369898 Mon Sep 17 00:00:00 2001 From: Techatrix Date: Thu, 5 Dec 2024 18:19:02 +0100 Subject: [PATCH] clarify Zig and ZLS version compatibility in the install tool page --- content/zls/install.smd | 15 ++++++++++++--- layouts/zls-install.shtml | 3 ++- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/content/zls/install.smd b/content/zls/install.smd index a5a9888..74bf8ae 100644 --- a/content/zls/install.smd +++ b/content/zls/install.smd @@ -43,7 +43,16 @@ RWR+9B91GBZ0zOjh6Lr17+zKf5BoSuFvrx2xSeDE57uIYvnKBGmMjOex Provided by [zigtools/release-worker](https://github.com/zigtools/release-worker). -[]($section.id('install-editor-extension')) -## Install Editor Extension +[]($section.id('zig-zls-version-compatibility')) +## Zig + ZLS version compatibility -Please header over to the "Editor Configuration" section to set up the editor of your choice. +If you decide to install Zig or ZLS through a different method (e.g. package managers), make sure that you install compatible versions: +- A tagged release of Zig should be used with the same tagged release of ZLS (and vice versa). +- A nightly build of Zig should be used with a nightly build of ZLS (and vice versa). + +The install tool above will automatically resolve compatible Zig and ZLS versions. + +[]($section.id('next-steps')) +## Next steps + +After installing ZLS, please head over to the "Editor Configuration" section to set up the editor(s) of your choice. diff --git a/layouts/zls-install.shtml b/layouts/zls-install.shtml index 5c302bb..4ed7418 100644 --- a/layouts/zls-install.shtml +++ b/layouts/zls-install.shtml @@ -154,6 +154,7 @@ - + + \ No newline at end of file