Skip to content

Commit 4754b06

Browse files
committed
docs: add one-command install to README
1 parent 9806b1c commit 4754b06

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

Main.xcworkspace/contents.xcworkspacedata

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,27 @@ Cupertino is a local, structured, AI-ready documentation system for Apple platfo
2929

3030
## Quick Start
3131

32-
> **Note:** All build and install commands must be run from the Packages directory (`cupertino/Packages/`). Once installed, `cupertino` can be called from anywhere.
32+
> **Note:** When building from source, commands must be run from the `Packages` directory. The one-command install works from anywhere.
3333

3434
### Requirements
3535

3636
- macOS 15+ (Sequoia)
37-
- Swift 6.2+
38-
- Xcode 16.0+
3937
- ~2-3 GB disk space for full documentation
4038

39+
*Building from source additionally requires Swift 6.2+ and Xcode 16.0+*
40+
4141
### Installation
4242

43+
**One-command install (recommended):**
44+
45+
```bash
46+
bash <(curl -sSL https://raw.githubusercontent.com/mihaelamj/cupertino/main/install.sh)
47+
```
48+
49+
This downloads a pre-built, signed, and notarized universal binary, installs it to `/usr/local/bin`, and downloads the documentation databases.
50+
51+
**Or build from source:**
52+
4353
```bash
4454
git clone https://github.com/mihaelamj/cupertino.git
4555
cd cupertino

0 commit comments

Comments
 (0)