docs: reflect cli-as-default-feature in README/CLAUDE.md/CHANGELOG (Refs #55)#57
Open
docs: reflect cli-as-default-feature in README/CLAUDE.md/CHANGELOG (Refs #55)#57
Conversation
…efs #55) PR #56 made `cli` a default feature and dropped the `whisper-apr-cli` bin alias. Docs were still telling users to invoke `cargo install whisper-apr --features cli` and reference the old alias. Refresh: - README "## Usage" + "## Installation" + "## CLI" — drop the `--features cli` flag, clarify library-only consumers should opt out via `default-features = false` and pick `["std", "simd", "parallel"]`. - CLAUDE.md "## Build Commands" — add `cargo install --path .` line so the next agent reading this knows the canonical install path; flip the WASM build to `--no-default-features --features wasm` so cli + parallel don't drag in for browser targets. - CHANGELOG "## [Unreleased]" — document the BREAKING (build-only) change for the default-feature flip and the bin-alias removal, plus the `load_audio_samples` fallback fix that was bundled with the lint-debt cleanup commit on the same PR. Co-Authored-By: Claude Opus 4.7 <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
--features clifrom install snippets, clarify library-only consumers should opt out viadefault-features = falsecargo install --path .to the canonical build commands; flip WASM build to opt out of cli + parallel[Unreleased]so the next release notes carry itWhy
PR #56 already shipped the code change but the docs still pointed users at the old
--features cliinstall path and the droppedwhisper-apr-clialias. This is a follow-up doc-only refresh.Test plan
cargo install whisper-apr(no flags) landswhisper-apron PATH (verified locally)--no-default-features --features wasmcargo build --release(default features) succeeds with cli compiled in🤖 Generated with Claude Code