getting-started: error running the getting started examples #1431
Labels
No labels
CI
all
basisu
blog
bug
build
contributor-friendly
core
correctness
deferred
dev
direct3d-headers
docs
driver-os-issue
duplicate
dxcompiler
editor
examples
experiment
feature-idea
feedback
flac
freetype
gamemode
gkurve
glfw
gpu
gpu-dawn
harfbuzz
help welcome
in-progress
infrastructure
invalid
libmach
linux-audio-headers
long-term
mach
mach.gfx
mach.math
mach.physics
mach.testing
model3d
needs-triage
object
opengl-headers
opus
os/linux
os/macos
os/wasm
os/windows
package-manager
priority
proposal
proposal-accepted
question
roadmap
slipped
stability
sysaudio
sysgpu
sysjs
validating-fix
vulkan-zig-generated
wayland-headers
website
wontfix
wrench
www
x11-headers
xcode-frameworks
zig-update
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
hexops/mach#1431
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Before filing an issue, please make sure you're using a supported Zig version: https://machengine.org/about/zig-version
While trying to follow the "Getting Started" instructions from the website here: https://machengine.org/
I am seeing this error when I run on MacOS:
I am using the latest Zig version: 0.15.1
If this is an unsupported Zig version, then maybe there could be a more clear error about a Zig version mismatch in the build steps? Or a more clear guide to how to downgrade Zig to a compatible version in the getting started steps?
Please note the first sentence of your issue:
0.15.1 isn't supported, it's likely that this is the issue. See https://machengine.org/docs/nominated-zig/ for details on nominated versions. Not sure why this wasn't caught by the build system or earlier in the compilation, I recall a clear error message being thrown in such cases.
Re downgrading, many people seem to use anyzig. Downloading the older version through the VS Code plugin might also work. I only have the nominated version installed right now, so I can't help you with any details.
Hello, thanks for your response!
I understand that it's not always possible to provide support for the most up-to-date version of certain languages or dependencies, but in those cases, I think it's nice to provide detail on the "getting started" information page about installing the dependencies correctly. Without this, the "getting started" guide is a little user unfriendly in my opinion.
I think providing information about using
anyzigand the "minimum compatible zig version" parameter would be one solution.Another solution would be providing a reproducible build environment for the supported zig version. I have created this pull request with a
shell.nixfile. In my opinion, this could be a better way to give new users a more seamless first experience in the repo.https://github.com/hexops/mach/pull/1432