Skip to content

README: document trowel install script (scripts/install-trowel.sh) #193

Description

@scuba10steve

Context

Added scripts/install-trowel.sh — downloads the latest (or a pinned) trowel release for the current OS/arch, verifies its checksum, and installs it to ~/.local/bin (override with TROWEL_INSTALL_DIR). If the install dir isn't on PATH, it prints the export PATH=... line to add.

Currently this is undocumented and only usable by running the script directly from a checkout.

Task

Update the README's "Download Native Binaries" section to document the script as the recommended install path, e.g.:

curl -fsSL https://raw.githubusercontent.com/orchard-cde/orchard/main/scripts/install-trowel.sh | bash

(or pin a version: ... | bash -s v0.4.0)

Keep the existing manual curl+tar instructions as a fallback for users who don't want to pipe a script to bash.

Long-term (out of scope for this issue)

Surface installation via the orchard website once it exists, rather than a raw GitHub URL.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions