Skip to content

Voice-to-text dictation app with local (Nvidia Parakeet/Whisper) and cloud models (BYOK). Privacy-first and available cross-platform.

Fix README instructions (#206)

Shay Nehmadbeab19779d5a
diff --git a/README.md b/README.md
index 52dcb72fe..8557d4f4b 100644
--- a/README.md
+++ b/README.md
@@ -69,7 +69,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
**Method A - Environment file**:
```bash
- cp env.example .env
+ cp .env.example .env
# Edit .env and add your API keys:
# OPENAI_API_KEY=your_openai_key
# ANTHROPIC_API_KEY=your_anthropic_key
@@ -81,14 +81,19 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
- Run the app and configure API keys through the Control Panel
- Keys are automatically saved and persist across app restarts
-4. **Run the application**:
+4. **Build the application**:
+ ```bash
+ npm run build
+ ```
+
+5. **Run the application**:
```bash
npm run dev # Development mode with hot reload
# OR
npm start # Production mode
```
-5. **Optional: Local Whisper from source** (only needed if you want local processing):
+6. **Optional: Local Whisper from source** (only needed if you want local processing):
```bash
npm run download:whisper-cpp
```