From 653007618bebcffe080ca76d4fa93a7ed813847c Mon Sep 17 00:00:00 2001 From: Jatin K Malik Date: Tue, 27 Jan 2026 23:38:29 -0800 Subject: [PATCH] docs: Clarify VOSK and Whisper dependency installation in README (#67) (#76) * docs: Clarify VOSK and Whisper dependency installation in README (#67) - VOSK: installs the vosk Python package from PyPI - Whisper: installs openai-whisper package from PyPI, which also pulls in PyTorch Closes #67 * chore: Add Claude workflow rules to gitignore --- .gitignore | 1 + README.md | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 0b2d353..68cbfd2 100644 --- a/.gitignore +++ b/.gitignore @@ -145,3 +145,4 @@ temp/ # Local Netlify folder .netlify +.claude-workflow-rules.md diff --git a/README.md b/README.md index c2886b2..594e12d 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,9 @@ This will: - Clone the repository to `~/.local/share/vocalinux-install` - Install all system dependencies - Set up a virtual environment in `~/.local/share/vocalinux/venv` -- Install **both VOSK and Whisper AI** speech engines +- Install **both VOSK and Whisper AI** speech engines: + - **VOSK**: installs the `vosk` Python package from PyPI + - **Whisper**: installs the `openai-whisper` package from PyPI, which also pulls in PyTorch (the ML framework Whisper requires) - Create a symlink at `~/.local/bin/vocalinux` - Download the default **Whisper tiny** speech model (~75MB)