Installation

This guide covers different ways to install ZIGX in your Zig project.

Requirements

• Zig: Version 0.15.0 or later (0.15.x recommended)
• Platform: Windows, macOS, or Linux

Using Zig Package Manager (Recommended)

Release Installation (Recommended)

Install the latest stable release (v0.0.1):

zig fetch --save https://github.com/muhammad-fiaz/zigx/archive/refs/tags/v0.0.1.tar.gz

Nightly Installation

Install the latest development version:

zig fetch --save git+https://github.com/muhammad-fiaz/zigx

Configure build.zig

Then in your build.zig:

const zigx_dep = b.dependency("zigx", .{
    .target = target,
    .optimize = optimize,
});
exe.root_module.addImport("zigx", zigx_dep.module("zigx"));

Manual Installation

If you prefer not to use the package manager:

Step 1: Clone Repository

git clone https://github.com/muhammad-fiaz/zigx.git
# or download and extract a release

Step 2: Add as Local Module

In your build.zig:

const std = @import("std");

pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});
    const optimize = b.standardOptimizeOption(.{});

    // Create ZIGX module from local path
    const zigx_module = b.addModule("zigx", .{
        .root_source_file = b.path("vendor/zigx/src/zigx.zig"),
        .target = target,
        .optimize = optimize,
    });

    const exe = b.addExecutable(.{
        .name = "your-app",
        .root_source_file = b.path("src/main.zig"),
        .target = target,
        .optimize = optimize,
    });

    exe.root_module.addImport("zigx", zigx_module);

    b.installArtifact(exe);
}

Verification

Test your installation:

// src/main.zig
const std = @import("std");
const zigx = @import("zigx");

pub fn main() !void {
    std.debug.print("ZIGX Version: {s}\n", .{zigx.VERSION});
    std.debug.print("Format Version: {d}\n", .{zigx.FORMAT_VERSION});
    std.debug.print("Compression Version: {d}\n", .{zigx.COMPRESSION_VERSION});
}

Build and run:

zig build run

Expected output:

ZIGX Version: 0.0.1
Format Version: 1
Compression Version: 1

Troubleshooting

Hash Mismatch

If you get a hash mismatch error:

# Re-fetch with --debug-hash to see the correct hash
zig fetch --debug-hash https://github.com/muhammad-fiaz/zigx/archive/refs/tags/v0.0.1.tar.gz

Module Not Found

Ensure the path in root_source_file is correct:

// Check if zigx.zig exists at this path
.root_source_file = b.path("path/to/zigx/src/zigx.zig"),

Zig Version Compatibility

ZIGX 0.0.1 requires Zig 0.15.0+. Check your version:

zig version

Next Steps

• Getting Started - Create your first archive
• Compression - Learn about compression modes