Skip to content

Commit 3e8c2af

Browse files
author
ksndmplb
committed
docs: update README for Windows support
1 parent c459cbf commit 3e8c2af

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![CodexMonitor](screenshot.png)
44

5-
CodexMonitor is a macOS Tauri app for orchestrating multiple Codex agents across local workspaces. It provides a sidebar to manage projects, a home screen for quick actions, and a conversation view backed by the Codex app-server protocol.
5+
CodexMonitor is a desktop Tauri app for orchestrating multiple Codex agents across local workspaces on macOS and Windows. It provides a sidebar to manage projects, a home screen for quick actions, and a conversation view backed by the Codex app-server protocol.
66

77
## Features
88

@@ -40,13 +40,13 @@ CodexMonitor is a macOS Tauri app for orchestrating multiple Codex agents across
4040
- Responsive layouts (desktop/tablet/phone) with tabbed navigation.
4141
- Sidebar usage and credits meter for account rate limits plus a home usage snapshot.
4242
- Terminal dock with multiple tabs for background commands (experimental).
43-
- In-app updates with toast-driven download/install, debug panel copy/clear, sound notifications, and macOS overlay title bar with vibrancy + reduced transparency toggle.
43+
- In-app updates with toast-driven download/install, debug panel copy/clear, sound notifications, and (macOS) overlay title bar with vibrancy + reduced transparency toggle.
4444

4545
## Requirements
4646

4747
- Node.js + npm
4848
- Rust toolchain (stable)
49-
- CMake (required for native dependencies; Whisper/dictation uses it on non-Windows)
49+
- CMake (required for native dependencies; Whisper/dictation uses it on macOS/Linux)
5050
- Codex installed on your system and available as `codex` in `PATH`
5151
- Git CLI (used for worktree operations)
5252
- GitHub CLI (`gh`) for the Issues panel (optional)
@@ -74,13 +74,15 @@ npm run tauri dev
7474

7575
## Release Build
7676

77-
Build the production Tauri bundle (app + dmg):
77+
Build the production Tauri bundle:
7878

7979
```bash
8080
npm run tauri build
8181
```
8282

83-
The macOS app bundle will be in `src-tauri/target/release/bundle/macos/`.
83+
Artifacts will be in:
84+
85+
- macOS: `src-tauri/target/release/bundle/macos/`
8486

8587
### Windows (opt-in)
8688

@@ -95,7 +97,10 @@ Artifacts will be in:
9597
- `src-tauri/target/release/bundle/nsis/` (installer exe)
9698
- `src-tauri/target/release/bundle/msi/` (msi)
9799

98-
Note: dictation is currently disabled on Windows builds (to avoid requiring LLVM/libclang for `whisper-rs`/bindgen).
100+
Notes:
101+
102+
- Dictation is currently disabled on Windows builds (to avoid requiring LLVM/libclang for `whisper-rs`/bindgen).
103+
- “Open in VS Code/Cursor” uses command targets (e.g. `code`, `cursor`) by default. If those commands are missing, enable their CLI shims on `PATH` or configure a full executable path in the app settings.
99104

100105
## Type Checking
101106

0 commit comments

Comments
 (0)