Skip to content

docs: only offer installs that work #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vyncint merged 1 commit into from
Aug 23, 2026
Merged

docs: only offer installs that work #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ listed under a **Changed** or **Removed** heading.

### Fixed

- **The README no longer promises Homebrew.** The line went in ahead of the
tap existing, on the assumption that the tap would follow within the hour.
It has not yet, and an install command that does not work is worse than one
that is not offered. The three routes documented are the three that are
verified against the real release.

- **The Windows binary is built.** The 0.6.2 release shipped Linux and macOS
archives and no `.zip`: the build step had no `shell: bash`, and Windows
runners default to PowerShell, where `"$TARGET"` expands to the empty string
Expand Down
40 changes: 12 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,31 +47,21 @@ labels around them stay text.
## Quickstart

**No Rust needed.** Every release ships static binaries for Linux, macOS and
Windows — [all four ways to install](#install) are below.
Windows. One command, no toolchain:

```sh
brew install vyncint/tap/mossaic # macOS and Linux
target=x86_64-unknown-linux-musl # or aarch64-unknown-linux-musl,
# aarch64-apple-darwin, x86_64-apple-darwin
curl -fsSL "https://github.com/vyncint/mossaic/releases/latest/download/mossaic-${target}.tar.gz" \
| tar xz --strip-components=1 --wildcards '*/mossaic*'
```

<details>
<summary>Without Homebrew — one command, no toolchain</summary>

```sh
# Linux x86_64. Swap the target for aarch64-unknown-linux-musl,
# x86_64-apple-darwin or aarch64-apple-darwin as needed.
curl -fsSL https://github.com/vyncint/mossaic/releases/latest/download/mossaic-x86_64-unknown-linux-musl.tar.gz \
| tar xz --strip-components=1 -C ~/.local/bin --wildcards '*/mossaic*'
```
Windows: take the `.zip` from the
[latest release](https://github.com/vyncint/mossaic/releases/latest).
Already have Rust? `cargo install mossaic --locked`.

The Linux builds are statically linked, so they run on any distribution
whatever its glibc. Windows users take the `.zip` from the
[releases page](https://github.com/vyncint/mossaic/releases/latest).

</details>

```sh
cargo install mossaic # if you have Rust 1.88+ already
```
[All the ways to install](#install), including checksum verification, are
below.

**Plan the art.** No account, no network — this is arithmetic:

Expand Down Expand Up @@ -471,15 +461,9 @@ palette is degraded on purpose, and what the capability probe actually sends.

## Install

Four ways, and only the last needs a Rust toolchain.

### Homebrew — macOS and Linux

```sh
brew install vyncint/tap/mossaic
```
Three ways, and only the last needs a Rust toolchain.

### A downloaded binary — anything else
### A downloaded binary

Every release attaches a static build for each platform, with a `.sha256`
beside it. Nothing to compile and nothing to keep up to date but the file
Expand Down