Skip to content

docs: Add local setup and deployment instructions to README - #7

Merged
tathagata merged 2 commits into
mainfrom
copilot/setup-local-deployment
Mar 10, 2026
Merged

tathagata merged 2 commits into
mainfrom
copilot/setup-local-deployment

Conversation

Copilot AI commented Mar 9, 2026 •

Copy link
Copy Markdown
Contributor

The README contained only a single cryptic line with no setup, installation, or usage guidance.

Changes

  • How It Works – pipeline diagram and per-component descriptions
  • Prerequisites – Python 3.11+, Swift 5.5+ (macOS TTS), microphone, internet, API key
  • Local Setup – 5-step walkthrough: clone → venv → pip install → ANTHROPIC_API_KEY → swift build
  • Running the Application – minimal wiring snippet showing how to compose and invoke the orchestrator; Handy offline-TTS alternative
  • Running Tests – pytest tests/ src/; clarifies no hardware/API key needed for tests
  • Project Structure – annotated directory tree
  • Troubleshooting – maps common error messages to fixes

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: tathagata <68151+tathagata@users.noreply.github.com>
Copilot AI changed the title [WIP] Add instructions for local setup and deployment docs: Add local setup and deployment instructions to README Mar 9, 2026
@tathagata
tathagata marked this pull request as ready for review March 10, 2026 13:37
@tathagata
tathagata merged commit da2be48 into main Mar 10, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants