Skip to content

docs(readme): add download and install guidance - #489

Merged
hkngln merged 6 commits into
alplabai:trunkfrom
snowyukitty:fix/readme-download-install
Oct 22, 2026
Merged

hkngln merged 6 commits into
alplabai:trunkfrom
snowyukitty:fix/readme-download-install

Conversation

@snowyukitty

Copy link
Copy Markdown
Contributor

Summary

Make the prebuilt Signex packages discoverable and usable without requiring a
Rust toolchain.

Closes #321.

Changes

  • add a rolling Download link and package table for every artifact shipped by
    the release workflow
  • document current platform and architecture availability, hardware
    requirements, and unsigned first-launch warnings
  • add single-download checksum verification guidance for Linux, macOS, and
    PowerShell
  • make the version badge follow the latest published release instead of a
    pinned tag

Validation

  • cargo fmt --all -- --check
  • cargo check --workspace
  • cargo test --workspace
  • git diff --check
  • checked the table against both release.yml and all nine v0.14.0 release
    assets
  • followed the Linux checksum example with the real v0.14.0 AppImage under
    BusyBox and confirmed the published hash matches
  • followed the PowerShell checksum example with the real v0.14.0 ARM64
    installer and x86_64 portable ZIP; both published hashes match

License compliance (issue #62)

  • This is original work, or derived only from sources whose licence I read
    and confirmed Apache-2.0-compatible.

Derived from something? Name the source and its licence: n/a

Labels

  • type: docs

Crates affected

  • signex-types
  • signex-engine
  • signex-library / signex-library-server
  • signex-sketch
  • signex-bake
  • signex-erc / signex-erc-dsl
  • signex-bom
  • signex-output
  • signex-renderer / signex-gfx
  • signex-3d-model-importer
  • signex-widgets / chrome-catalog
  • signex-app

Checklist

Hard CI gates:

  • cargo check --workspace compiles
  • cargo test --workspace passes
  • cargo deny check licenses — not run locally; no dependency or manifest
    changed
  • License-compliance question above is answered

Advisory:

  • cargo fmt --all clean
  • cargo clippy --workspace — not run for this documentation-only change
  • New code has tests where appropriate — no code changed; release links and
    the Linux and PowerShell checksum paths were exercised directly
  • Milestone is set on this PR

@github-actions github-actions Bot added the area: docs Docs and top-level markdown label Jul 23, 2026
@alpCaner alpCaner added this to the v1.0.0 — Community Preview milestone Jul 23, 2026

@alpCaner alpCaner left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed — thanks, this is clean and well-validated. Milestone set to v1.0.0 — Community Preview (matches #321, which it closes).

Verified:

  • Version badge → self-updating releases/latest shields query — good, no more per-release edit.
  • Download table matches all 9 assets shipped by release.yml.
  • Checksum snippets are correct on all three platforms — grep -F " $file" matches sha256sum/shasum -a 256's two-space output format, and the PowerShell Select-String -SimpleMatch + -eq path is sound.

No code, no gate risk. Approving — good to merge.

@alpCaner alpCaner left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Clean docs change — good to merge.

@hkngln
hkngln enabled auto-merge October 22, 2026 20:01
@hkngln
hkngln added this pull request to the merge queue Oct 22, 2026
Merged via the queue into alplabai:trunk with commit 9b96b9a Oct 22, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Docs and top-level markdown

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): add a Download and Install section for the shipped installers

3 participants