Skip to content

docs: compiler's Zig dependency is not documented in README/CONTRIBUTING #27

Description

@Voctl

docs: compiler's Zig dependency is not documented

Observation:
When building, compiler/src/builder.rs invokes the zig command from the system PATH:

rust pub fn get_zig_path() -> &'static str { "zig" } ​

This means the Zig toolchain must be pre-installed on the user's machine for azcli build to work. This requirement is not mentioned in README.md, CONTRIBUTING.md, or any other documentation.

Impact:
A new user without Zig installed will run into a confusing, unhelpful error when trying to build, with no clue as to the actual cause.

Suggestion:

  • Add a "Requirements" section to the README specifying Zig (and the required version).
  • Alternatively, have the build command detect a missing Zig installation and show a clear message (e.g. "Zig not found — install it from: ...").

P.S: Ik its not a big problem for developers but it is for new users and who dont know anything about the structure of AzLang

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions