Initial commit: Add project README with overview

This commit is contained in:
jatinkrmalik
2025-04-07 16:54:13 -05:00
commit c953ef21fd
+28
View File
@@ -0,0 +1,28 @@
# Ubuntu Voice Typing
A seamless voice dictation system for Ubuntu, comparable to the built-in solutions on macOS and Windows.
## Overview
Ubuntu Voice Typing provides a user-friendly speech-to-text solution for Linux users with:
- Activation via customizable keyboard shortcuts
- Real-time transcription with minimal latency
- Universal compatibility across applications
- Offline operation for privacy and reliability
- Visual indicators for microphone status
## Technical Foundation
This project leverages existing open-source technologies:
- Speech recognition: VOSK API / Whisper
- Text injection: xdotool (X11) / ydotool (Wayland)
- User interface: GTK for system tray and settings
## Development Status
This project is under active development. See the project roadmap for upcoming features.
## License
This project is open source and will be licensed under [LICENSE TO BE DETERMINED].