Skip to content

Documentation outdated: README.md - Missing Windows binary install instructions #918

@github-actions

Description

@github-actions

Problem

The README installation section only lists pre-built binaries for Linux (x86_64, aarch64) and macOS (x86_64, aarch64). However, the CHANGELOG for v2.3.0-rust explicitly states:

Pre-built binaries for Linux, macOS, Windows

Lines 11–27 of README.md — the "Install" section — have no azlin-windows-*.zip or .exe download instructions, despite Windows binaries being available.

Impact

Windows users reading the README are directed only toward WSL/uvx workarounds, or must discover the Windows binary independently from GitHub Releases. This is a user-facing gap for an install path that was shipped in v2.3.0-rust.

Suggested Fix

Add a Windows install block to the ### Option 1: Download Pre-Built Binary section, for example:

# Windows x86_64
curl -sSL https://github.com/rysweet/azlin/releases/latest/download/azlin-windows-x86_64.zip -o azlin.zip
# Extract azlin.exe and add to PATH

Verify the exact artifact name from the GitHub Releases page and update accordingly.

File

README.md — lines 11–27 (Installation / Option 1)

Generated by Documentation Freshness Checker

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions