Skip to content

docs: add copy-paste Quickstart with install and expected output - #7

Closed
AshSgDe29071999 wants to merge 1 commit into
AgentPostmortem:mainfrom
AshSgDe29071999:docs/readme-quickstart
Closed

docs: add copy-paste Quickstart with install and expected output#7
AshSgDe29071999 wants to merge 1 commit into
AgentPostmortem:mainfrom
AshSgDe29071999:docs/readme-quickstart

Conversation

@AshSgDe29071999

Copy link
Copy Markdown
Contributor

Summary

Adds a Quickstart section so first-run is install → one command → known output, without hunting through Demo/Install separately.

  • Install from PyPI (voiceeval-cli) or editable clone
  • Minimal command: voiceeval check fixtures/misheard_call.json
  • Expected FAIL output for the misheard fixture and PASS for the good fixture (captured from a real run)
  • Install section points at Quickstart to avoid drift

Test plan

  • Docs-only change
  • Commands match shipped fixtures and CLI output from voiceeval check

Fixes #1

First-run path: install (PyPI or editable), `voiceeval check` on the
shipped misheard fixture, and the real FAIL/PASS output blocks.

Fixes #1
@royalpinto007

Copy link
Copy Markdown
Collaborator

Thanks for the PR! The clone-based Quickstart works, but the PyPI path fails because fixtures/ is not included in the wheel. Could you provide a self-contained PyPI example, include the fixtures in the package, or mark these commands as clone-only? Everything else looks good. Please ping me once updated.

@AshSgDe29071999 AshSgDe29071999 closed this by deleting the head repository Aug 11, 2026
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.

Add a copy-paste quickstart to the README

2 participants