docs: overhaul README with prerequisites, badges, and cleaner structure#7
Open
Krivoblotsky wants to merge 1 commit into
Open
docs: overhaul README with prerequisites, badges, and cleaner structure#7Krivoblotsky wants to merge 1 commit into
Krivoblotsky wants to merge 1 commit into
Conversation
- Add badge row: PyPI version, Python versions, platform, license, arXiv - Add Prerequisites section documenting the macOS Accessibility permission requirement — the most common source of silent failures for new users - Separate Python API and CLI into distinct sections - Document all CLI flags as a table - Document screenshot output files as a table - Remove duplicate/confusing "Output" section that described Python API returns under the CLI heading - Add Contributing and Citation sections Co-Authored-By: Claude Sonnet 4.6 <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
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.
Summary
Test plan
🤖 Generated with Claude Code