From 447f2385dcfbec99c6ea6d0488ebb486a0c75288 Mon Sep 17 00:00:00 2001 From: CJ Pais Date: Mon, 23 Jun 2025 09:04:19 -0700 Subject: [PATCH] update instructions to include downloading the models to run when building locally --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index a097330..60baf62 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,30 @@ bun run tauri dev bun run tauri build ``` +**Model Files Setup:** + +For development, you need to download the required model files: + +1. Create the models directory inside the resources folder: + ```bash + mkdir -p src-tauri/resources/models + ``` + +2. Download the required model files: + ```bash + # Download Whisper model (Small model) + curl -o src-tauri/resources/models/ggml-small.bin https://blob.handy.computer/ggml-small.bin + + # Download Silero VAD model + curl -o src-tauri/resources/models/silero_vad_v4.onnx https://blob.handy.computer/silero_vad_v4.onnx + ``` + +**Alternative Whisper Models:** + +The `ggml-small.bin` file can be replaced with any GGML model for whisper.cpp. Available models can be found at [huggingface.co/ggerganov/whisper.cpp](https://huggingface.co/ggerganov/whisper.cpp/tree/main). + +**Important:** If you use a different Whisper model, you'll need to update the filename reference in the manager's transcription code to match your chosen model file. + ## Architecture Handy is built as a Tauri application combining: