Skip to content

Commit 544488c

Browse files
heqikaicursoragent
andcommitted
docs(readme): add macOS dmg download link and apps/desktop layout
Document Baidu Netdisk distribution for Apple Silicon builds and expand desktop build/output instructions for contributors. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 93bcd0f commit 544488c

1 file changed

Lines changed: 27 additions & 4 deletions

File tree

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,9 +211,21 @@ Roadmap and deferred work: [docs/codedelta/ROADMAP.md](docs/codedelta/ROADMAP.md
211211

212212
## Desktop (macOS)
213213

214-
CodeDelta ships a **macOS desktop app** (`apps/desktop`) that bundles Node 20 and the API server — no separate Node install required for end users.
214+
CodeDelta ships a **macOS desktop app** ([`apps/desktop/`](apps/desktop/)) — a Tauri 2 shell that bundles Node 20 and the API server. End users do not need a separate Node install.
215215

216-
**Requirements to build:** macOS (arm64 or x64), [Xcode Command Line Tools](https://developer.apple.com/xcode/resources/), [Rust 1.88+](https://rustup.rs/) (use `rustup`; Homebrew `cargo` alone may be too old), and repo dev dependencies (`npm ci`).
216+
### Download (Apple Silicon)
217+
218+
Pre-built **unsigned** `.dmg` (arm64 / M1–M4):
219+
220+
- [百度网盘](https://pan.baidu.com/s/16DL3nvpFA9FR6UsskqoFyA?pwd=frog) · 提取码: `frog`
221+
222+
Install: open the dmg → drag **CodeDelta** to Applications. If macOS blocks launch, right-click the app → **Open**. Requires **git** on `PATH`.
223+
224+
**Runtime data:** `~/Library/Application Support/CodeDelta` (repos, snapshots, settings).
225+
226+
### Build from source
227+
228+
**Requirements:** macOS (arm64 or x64), [Xcode Command Line Tools](https://developer.apple.com/xcode/resources/), [Rust 1.88+](https://rustup.rs/) via `rustup` (Homebrew `cargo` alone may be too old), and repo dev dependencies (`npm ci`).
217229

218230
```bash
219231
# One-time: stage embedded Node + server runtime (~200MB under apps/desktop/src-tauri/resources/runtime/)
@@ -226,9 +238,20 @@ npm run build:desktop
226238
npm run dev:desktop
227239
```
228240

229-
**Runtime data:** `~/Library/Application Support/CodeDelta` (repos, snapshots, settings).
241+
Output: `apps/desktop/src-tauri/target/release/bundle/dmg/CodeDelta_*_aarch64.dmg` (or copy to `release/` manually if `bundle_dmg.sh` fails).
242+
243+
**`apps/desktop/` layout:**
244+
245+
```
246+
apps/desktop/
247+
package.json # tauri dev / build:app scripts
248+
src-tauri/
249+
tauri.conf.json # window, bundle, embedded resources
250+
src/server.rs # spawn bundled Node API on launch
251+
resources/runtime/ # generated by npm run stage:desktop (gitignored)
252+
```
230253

231-
**Git:** must be on `PATH` for import/compare/trace (the app shows a banner if `git` is missing).
254+
**Git:** the app shows a banner if `git` is missing.
232255

233256
| Variable | Desktop default | Meaning |
234257
|----------|-----------------|---------|

0 commit comments

Comments
 (0)