Docs/windows support#10
Open
alabulei1 wants to merge 4 commits into
Open
Conversation
Windows support landed in #8 (portable-pty-psmux / ConPTY) but the docs only mentioned it in a one-line note. Add real Windows usage: - README.md: expand Platform Support into a per-platform table with requirements, plus a "Running on Windows" section (vibetty-windows-x64.exe, PowerShell $env: vars, %PATH% placement) - docs/README.zh.md: add the equivalent platform-support section in Chinese Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The README buried installation inside the Whisper config section and presented Whisper/WebVosk as equal options. Restructure to match how the product actually works: - Add a "How it works" section: VibeKeys Max mic streams audio over WebSocket to the server, which transcribes via a Whisper API and injects text into the terminal + agent. (Audio source is the keyboard, not the browser; the browser only displays the terminal.) - Split Installation out of Configuration; one PATH block (was duplicated), per-OS release asset names, Windows binary. - Make Whisper the default path; demote WebVosk to "offline, no API key". - Quick Start now covers pairing the VibeKeys Max via /setup over Bluetooth. - Fix the WebVosk `-- --` typo. - Mirror the same structure in docs/README.zh.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Vibetty runs whatever follows `--` in a PTY; there is no Claude-specific code. Reflect that: - Tagline/features now name Claude Code, Codex, Gemini CLI, OpenCode, aider as examples (Vibetty has no hard dependency on any one agent). - Quick Start step 3 lists launch commands per agent (vibetty -- claude / codex / gemini / opencode / aider / bash). - Mirror both in docs/README.zh.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.