Jatin K MalikandGitHub
f8e5de5621
* feat: Make Whisper tiny the default engine and download during install - Changed default engine from 'vosk' to 'whisper' in config_manager.py - Changed default model_size from 'small' to 'tiny' in config_manager.py - Added install_whisper_model() function to install.sh that downloads the Whisper tiny model (~75MB) during installation - Whisper model is downloaded when Whisper package is installed (in non-interactive mode or with --with-whisper flag) - Updated installation summary to show Whisper model status - Updated documentation (README.md, INSTALL.md, SECURITY.md, USER_GUIDE.md) to reflect Whisper tiny as the default engine This provides a better out-of-box experience: users can install and immediately use Vocalinux without any additional downloads or prompts. * test: Update test to reflect whisper as default engine
3.1 KiB
3.1 KiB
User Guide
This guide explains how to use Vocalinux effectively.
Getting Started
After installing Vocalinux (see the Installation Guide), you can start the application from the terminal or add it to your startup applications.
Basic Usage
Starting and Stopping Voice Typing
- Launch the application: Run
vocalinuxin a terminal or launch it from your application menu - Find the tray icon: Look for the microphone icon in your system tray
- Start voice typing: Click the tray icon and select "Start Voice Typing" from the menu, or use the double-tap Ctrl keyboard shortcut
- Speak clearly: As you speak, your words will be transcribed into the currently focused application
- Stop voice typing: Click the tray icon and select "Stop Voice Typing" when you're done, or use the double-tap Ctrl keyboard shortcut again
Understanding the Status Icons
- Microphone off (gray): Voice typing is inactive
- Microphone on (blue): Voice typing is active and listening
- Microphone processing (orange): Voice typing is processing your speech
Voice Commands
Vocalinux supports several commands that you can speak to control formatting:
| Command | Action |
|---|---|
| "new line" or "new paragraph" | Inserts a line break |
| "period" or "full stop" | Types a period (.) |
| "comma" | Types a comma (,) |
| "question mark" | Types a question mark (?) |
| "exclamation point" or "exclamation mark" | Types an exclamation point (!) |
| "semicolon" | Types a semicolon (;) |
| "colon" | Types a colon (:) |
| "delete that" or "scratch that" | Deletes the last sentence |
| "capitalize" or "uppercase" | Capitalizes the next word |
| "all caps" | Makes the next word ALL CAPS |
Tips for Better Recognition
- Use a good microphone: A quality microphone significantly improves recognition accuracy
- Speak clearly: Enunciate your words clearly but naturally
- Moderate pace: Don't speak too quickly or too slowly
- Quiet environment: Minimize background noise when possible
- Learn commands: Familiarize yourself with voice commands for punctuation and formatting
- Use larger models: For better accuracy, use
vocalinux --model mediumor--model large
Customization
Keyboard Shortcut
Vocalinux uses a double-tap Ctrl keyboard shortcut for starting and stopping voice typing:
- Double-tap Ctrl: Quickly press the Ctrl key twice to toggle voice typing on or off
- The time between taps should be less than 0.3 seconds to be recognized as a double-tap
Model Settings
You can change the speech recognition model for better accuracy or faster performance:
- Open settings from the tray icon menu
- Go to the "Recognition" tab
- Select your preferred model size (tiny is the default, use larger models for better accuracy)
- Choose between Whisper (default, more accurate) and VOSK (lighter weight, faster)
Troubleshooting
If you encounter issues, check the Installation Guide troubleshooting section or run the application with debug logging:
vocalinux --debug
Check the logs for error messages and possible solutions.