105 lines
5.2 KiB
Markdown
105 lines
5.2 KiB
Markdown
<div align="center">
|
|
<img src="VoiceInk/Assets.xcassets/AppIcon.appiconset/256-mac.png" width="180" height="180" />
|
|
<h1>VoiceInk</h1>
|
|
<p>Voice to text app for macOS to transcribe what you say to text almost instantly</p>
|
|
|
|
[](https://www.gnu.org/licenses/gpl-3.0)
|
|
|
|
[](https://github.com/Beingpax/VoiceInk/releases)
|
|
|
|
|
|
<p>
|
|
<a href="https://tryvoiceink.com">Website</a> •
|
|
<a href="https://www.youtube.com/@tryvoiceink">YouTube</a>
|
|
</p>
|
|
|
|
<a href="https://tryvoiceink.com">
|
|
<img src="https://img.shields.io/badge/Download%20Now-Latest%20Version-blue?style=for-the-badge&logo=apple" alt="Download VoiceInk" width="250"/>
|
|
</a>
|
|
</div>
|
|
|
|
---
|
|
|
|
VoiceInk is a native macOS application that transcribes what you say to text almost instantly. You can find all the information and download the app from [here](https://tryvoiceink.com).
|
|
|
|
|
|
|
|
After dedicating the past 5 months to developing this app, I've decided to open source it for the greater good.
|
|
|
|
My goal is to make it **the most efficient and privacy-focused voice-to-text solution for macOS** that is a joy to use. While the source code is now open for experienced developers to build and contribute, purchasing a license helps support continued development and gives you access to automatic updates, priority support, and upcoming features.
|
|
|
|
## Features
|
|
|
|
- 🎙️ **Accurate Transcription**: Local AI models that transcribe your voice to text with 99% accuracy, almost instantly
|
|
- 🔒 **Privacy First**: 100% offline processing ensures your data never leaves your device
|
|
- ⚡ **Power Mode**: Intelligent app detection automatically applies your perfect pre-configured settings based on the app/ URL you're on
|
|
- 🧠 **Context Aware**: Smart AI that understands your screen content and adapts to the context
|
|
- 🎯 **Global Shortcuts**: Configurable keyboard shortcuts for quick recording and push-to-talk functionality
|
|
- 📝 **Personal Dictionary**: Train the AI to understand your unique terminology with custom words, industry terms, and smart text replacements
|
|
- 🔄 **Smart Modes**: Instantly switch between AI-powered modes optimized for different writing styles and contexts
|
|
- 🤖 **AI Assistant**: Built-in voice assistant mode for a quick chatGPT like conversational assistant
|
|
|
|
## Get Started
|
|
|
|
### Download
|
|
Get the latest version with a free trial from [tryvoiceink.com](https://tryvoiceink.com). Your purchase helps me work on VoiceInk full-time and continuously improve it with new features and updates.
|
|
|
|
#### Homebrew
|
|
Alternatively, you can install VoiceInk via `brew`:
|
|
|
|
```shell
|
|
brew install --cask voiceink
|
|
```
|
|
|
|
### Build from Source
|
|
As an open-source project, you can build VoiceInk yourself by following the instructions in [BUILDING.md](BUILDING.md). However, the compiled version includes additional benefits like automatic updates, priority support via Discord and email, and helps fund ongoing development.
|
|
|
|
## Requirements
|
|
|
|
- macOS 14.0 or later
|
|
|
|
## Documentation
|
|
|
|
- [Building from Source](BUILDING.md) - Detailed instructions for building the project
|
|
- [Contributing Guidelines](CONTRIBUTING.md) - How to contribute to VoiceInk
|
|
- [Code of Conduct](CODE_OF_CONDUCT.md) - Our community standards
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions! However, please note that all contributions should align with the project's goals and vision. Before starting work on any feature or fix:
|
|
|
|
1. Read our [Contributing Guidelines](CONTRIBUTING.md)
|
|
2. Open an issue to discuss your proposed changes
|
|
3. Wait for maintainer feedback
|
|
|
|
For build instructions, see our [Building Guide](BUILDING.md).
|
|
|
|
## License
|
|
|
|
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
|
|
|
## Support
|
|
|
|
If you encounter any issues or have questions, please:
|
|
1. Check the existing issues in the GitHub repository
|
|
2. Create a new issue if your problem isn't already reported
|
|
3. Provide as much detail as possible about your environment and the problem
|
|
|
|
## Acknowledgments
|
|
|
|
### Core Technology
|
|
- [whisper.cpp](https://github.com/ggerganov/whisper.cpp) - High-performance inference of OpenAI's Whisper model
|
|
- [FluidAudio](https://github.com/FluidInference/FluidAudio) - Used for Parakeet model implementation
|
|
|
|
### Essential Dependencies
|
|
- [Sparkle](https://github.com/sparkle-project/Sparkle) - Keeping VoiceInk up to date
|
|
- [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts) - User-customizable keyboard shortcuts
|
|
- [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin) - Launch at login functionality
|
|
- [MediaRemoteAdapter](https://github.com/ejbills/mediaremote-adapter) - Media playback control during recording
|
|
- [Zip](https://github.com/marmelroy/Zip) - File compression and decompression utilities
|
|
|
|
|
|
---
|
|
|
|
Made with ❤️ by Pax
|