Skip to content

Commit e9d8666

Browse files
committed
docs(README): Homebrew tap as the default install path
1 parent 8353c1f commit e9d8666

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,35 @@ MD_AudioBirds_V1; model-agnostic via TOML manifests.
66

77
## Quickstart
88

9-
Clone the repo and run the install wrapper (CWD = repo root):
9+
### Easiest: Homebrew (macOS arm64 / brew-Linux x86_64)
1010

1111
```bash
12-
# Linux / macOS
12+
brew tap microsoft/sparrow-engine
13+
brew install sparrow-engine # CPU; works on macOS arm64 + brew-Linux x86_64
14+
brew install sparrow-engine-gpu # GPU; brew-Linux x86_64 + NVIDIA only
15+
16+
spe device # {"device":"cpu"} or {"device":"cuda:0"}
17+
spe detect /path/to/photos --model MDV6-yolov10-e --recursive --print
18+
```
19+
20+
Both formulas can coexist (separate binaries `spe` + `spe-gpu`; shared model cache at `~/.sparrow-engine/models/`). The GPU formula installs a wrapper that auto-discovers `libcudnn.so.9` + `libnvjpeg.so.12` from common host locations — no `LD_LIBRARY_PATH` setup needed for production users. See `brew info sparrow-engine-gpu` for the full search order and `docs/user-manual.md §2.4` for the other install paths.
21+
22+
### Alternative install paths
23+
24+
If brew isn't right for your environment (server distro without brew-Linux, Windows, etc.), the install wrapper handles probe-and-install for Linux / macOS / Windows:
25+
26+
```bash
27+
# Linux / macOS — clone the repo and run from its root
1328
bash installer/sparrow-engine-install.sh
1429
```
1530

1631
```powershell
17-
# Windows PowerShell
32+
# Windows PowerShell — clone the repo and run from its root
1833
installer\sparrow-engine-install.ps1
1934
```
2035

2136
The wrapper probes hardware once, picks the right CPU or GPU build, and
22-
installs the matching CLI binary plus the Python wheel into `~/.sparrow_engine/`.
37+
installs the matching CLI binary plus the Python wheel into `~/.sparrow-engine/`.
2338
Pass `--flavor cpu` or `--flavor gpu` to skip the probe. Pass `--docker`
2439
to install the HTTP-server image instead.
2540

0 commit comments

Comments
 (0)