summaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAiden Cline <[email protected]>2026-01-06 13:07:20 -0600
committerAiden Cline <[email protected]>2026-01-06 13:07:20 -0600
commit494e03490e50852c7f67f1a61aa4b44f30eebb00 (patch)
tree20dc80917a5517e9e5e78c6117631b541a54b110 /CONTRIBUTING.md
parent675eba65886004eb90ef163f5bc33b5832427603 (diff)
downloadopencode-494e03490e50852c7f67f1a61aa4b44f30eebb00.tar.gz
opencode-494e03490e50852c7f67f1a61aa4b44f30eebb00.zip
docs: fix desktop stuff
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b73129b2a..08ab0159c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -83,12 +83,30 @@ This starts a local dev server at http://localhost:5173 (or similar port shown i
### Running the Desktop App
-The desktop app is a native Tauri application that wraps the web UI. To run it:
+The desktop app is a native Tauri application that wraps the web UI.
+
+To run the native desktop app:
+
+```bash
+bun run --cwd packages/desktop tauri dev
+```
+
+This starts the web dev server on http://localhost:1420 and opens the native window.
+
+If you only want the web dev server (no native shell):
```bash
bun run --cwd packages/desktop dev
```
+To create a production `dist/` and build the native app bundle:
+
+```bash
+bun run --cwd packages/desktop tauri build
+```
+
+This runs `bun run --cwd packages/desktop build` automatically via Tauri’s `beforeBuildCommand`.
+
> [!NOTE]
> Running the desktop app requires additional Tauri dependencies (Rust toolchain, platform-specific libraries). See the [Tauri prerequisites](https://v2.tauri.app/start/prerequisites/) for setup instructions.