Skip to content

Fix installation docs and build script for Swift version#19

Open
aeschylus wants to merge 1 commit into
sayhar:mainfrom
aeschylus:fix/installation-docs
Open

Fix installation docs and build script for Swift version#19
aeschylus wants to merge 1 commit into
sayhar:mainfrom
aeschylus:fix/installation-docs

Conversation

@aeschylus
Copy link
Copy Markdown

Summary

  • Add missing prerequisites for Swift version (uv and Python 3.13)
  • Fix build script to dynamically find Python 3.13.x instead of hardcoding version
  • Fix model cache location in docs (~/.cache/huggingface/ not ~/.cache/whisper/)
  • Add Swift source files to Files section
  • Add troubleshooting entries for common installation issues

Context

I tried following the README to install the Swift version and ran into several issues:

  1. uv: command not found - The README only listed uv as a prerequisite for the Python version, but the Swift build script requires it too
  2. Empty Python bundle - After installing uv, the build "succeeded" but the Python bundle was empty because Python 3.13 wasn't installed via uv python install 3.13
  3. Hardcoded Python version - The build script expected cpython-3.13.5 but uv installed 3.13.11, causing a silent failure

Test plan

  • Verified build works with updated script on fresh uv python install 3.13
  • Verified build fails with clear error message when Python 3.13 is not installed
  • App runs successfully after installation

🤖 Generated with Claude Code

The README was missing critical prerequisites for the Swift version:
- uv package manager is required (was only listed for Python version)
- Python 3.13 must be installed via `uv python install 3.13`

The build script had a hardcoded Python version (3.13.5) that would
silently fail when a different patch version was installed. Now it
dynamically finds the latest 3.13.x and fails with a clear error
message if Python isn't installed.

Additional README improvements:
- Fixed model cache location (~/.cache/huggingface/ not ~/.cache/whisper/)
- Added Swift source files to the Files section
- Added troubleshooting entries for common issues
- Fixed step numbering in installation instructions

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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