Skip to content

docs: reflect macOS Apple Silicon support; add CI/PyPI badges#15

Merged
pretyflaco merged 1 commit intomainfrom
docs/macos-support-accuracy
May 5, 2026
Merged

docs: reflect macOS Apple Silicon support; add CI/PyPI badges#15
pretyflaco merged 1 commit intomainfrom
docs/macos-support-accuracy

Conversation

@pretyflaco
Copy link
Copy Markdown
Owner

Summary

The "Linux only" framing in README.md and REQUIREMENTS.md was accurate before v0.6.0 but is now misleading. PR #4 (@openoms) plus the v0.6.0 follow-ups (#10#14) added MLX Whisper ASR + MPS torch device support, so the post-capture pipeline (transcribe / label / sync / summarize) works on macOS Apple Silicon.

Audio capture (meet record / meet run) still requires Linux because meet_record.capture shells out to ffmpeg -f pulse against PulseAudio/PipeWire monitor sources.

This PR splits the OS-claim per subcommand, fixes three falsehoods, and adds CI/PyPI badges.

Changes

README.md

  • CI status and PyPI version badges at the top.
  • Requirements section restructured into "Linux desktop (full pipeline)" + "macOS Apple Silicon (post-capture pipeline)".
  • --device option help updated to note the auto-detected default introduced by Apple Silicon: auto-default --device cpu and --torch-device mps on Darwin/arm64 #8 (cpu on Apple Silicon, cuda elsewhere).
  • Limitations bullet rewritten — the per-subcommand truth replaces the over-broad "Linux only".
  • FAQ macOS answer corrected; new entry cross-links vezir for Mac-as-server deployments.

REQUIREMENTS.md

  • Operating System section bumped to acknowledge macOS Apple Silicon support for the post-capture pipeline as of v0.6.0.

No code changes; no version bump.

Verification

ruff check meet/transcribe.py meet/cli.py tests/test_transcribe.py tests/test_utils.py

All checks pass. CI workflow will run on this PR.

…link vezir

The 'Linux only' framing in the README and REQUIREMENTS.md was accurate
before v0.6.0 but is now misleading.  PR #4 (openoms) and the v0.6.0
follow-ups added MLX Whisper ASR + MPS torch device support, so the
post-capture pipeline (transcribe, label, sync, summarize) now works on
macOS Apple Silicon.  Audio capture (meet record / meet run) still
requires Linux because meet_record.capture shells out to ffmpeg -f pulse
against PulseAudio/PipeWire monitor sources.

README:
- Add CI status and PyPI version badges at the top.
- Rewrite Requirements section to split Linux desktop (full pipeline)
  from macOS Apple Silicon (post-capture pipeline).
- Update transcribe --device option help to note the auto-detected
  default introduced by issue #8.
- Replace 'Linux only' Limitations bullet with a precise per-subcommand
  statement.  Add explicit 'Windows is not supported.'
- FAQ macOS answer rewritten; new FAQ entry cross-links vezir for
  Mac-as-server deployments alongside the Android client.

REQUIREMENTS.md:
- Operating System section bumped to acknowledge macOS Apple Silicon
  support for the post-capture pipeline as of v0.6.0.

No code changes.
@pretyflaco pretyflaco merged commit f36b3f7 into main May 5, 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.

1 participant