Getting Started

BugNarrator is a local-first narrated testing tool with a production macOS app and an in-progress native Windows workspace.

This page mirrors the canonical onboarding guidance in the repository and points back to the maintainer-only docs when you need more depth.

If You Are A Tester

1. Download the latest DMG from GitHub Releases.
2. Install BugNarrator.app into Applications.
3. Open BugNarrator and add your OpenAI API key in Settings.
4. Open Show Recording Controls and start a narrated session.
5. Follow the Tester Narration Guide during real testing passes.

If You Are A Maintainer

Start with these canonical repository docs:

• Architecture Overview
• Product Spec
• Development Setup
• Testing Guide
• Release Process
• GitHub Issues
• Roadmap History

If You Are Working On Windows Support

Use these docs first:

• Product Spec
• Windows Workspace README
• Windows Implementation Roadmap
• Windows Validation Checklist
• Cross-Platform Guidelines
• Cross-Platform Parity Matrix