103 lines
4.2 KiB
Markdown
103 lines
4.2 KiB
Markdown
# <img src="VoiceInk/Assets.xcassets/AppIcon.appiconset/64-mac.png" width="32" height="32" /> VoiceInk
|
|
|
|
<div align="center">
|
|
<img src="VoiceInk/Assets.xcassets/AppIcon.appiconset/256-mac.png" width="180" height="180" />
|
|
<h1>VoiceInk</h1>
|
|
<p>Transform your voice into text, instantly.</p>
|
|
|
|
[](https://www.gnu.org/licenses/gpl-3.0)
|
|
|
|
[](https://github.com/Beingpax/VoiceInk/releases)
|
|
|
|
<!-- Add Discord badge once link is provided -->
|
|
|
|
<p>
|
|
<img src="https://img.shields.io/github/stars/Beingpax/VoiceInk?style=social" alt="GitHub stars" />
|
|
<img src="https://img.shields.io/github/forks/Beingpax/VoiceInk?style=social" alt="GitHub forks" />
|
|
<img src="https://img.shields.io/github/issues/Beingpax/VoiceInk" alt="GitHub issues" />
|
|
<img src="https://img.shields.io/github/last-commit/Beingpax/VoiceInk" alt="Last commit" />
|
|
</p>
|
|
|
|
<p>
|
|
<a href="https://tryvoiceink.com">Website</a> •
|
|
<a href="https://www.youtube.com/@tryvoiceink">YouTube</a> •
|
|
<a href="https://github.com/Beingpax/VoiceInk/discussions">Discussions</a>
|
|
</p>
|
|
|
|
<br />
|
|
|
|
<div style="background-color: #f8f9fa; padding: 20px; border-radius: 8px; margin: 20px 0;">
|
|
<h3>Ready to Transform Your Voice into Text?</h3>
|
|
<a href="https://tryvoiceink.com">
|
|
<img src="https://img.shields.io/badge/Download-Latest%20Version-blue?style=for-the-badge&logo=apple" alt="Download VoiceInk" width="250"/>
|
|
</a>
|
|
<p style="margin-top: 10px; font-size: 0.9em;">macOS 14.0 or later required</p>
|
|
</div>
|
|
</div>
|
|
|
|
---
|
|
|
|
VoiceInk is a powerful macOS application that transforms your voice into text in real-time, providing a seamless and efficient way to capture your thoughts, create content, and transcribe audio.
|
|
|
|
## Features
|
|
|
|
- 🎙️ Real-time voice transcription
|
|
- 💻 Native macOS application
|
|
- 🚀 Powered by whisper.cpp for efficient, local transcription
|
|
- 🔒 Privacy-focused: All processing happens locally on your device
|
|
- ⚡ Fast and responsive interface
|
|
- 📝 Easy-to-use text editor
|
|
|
|
## 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
|
|
|
|
Special thanks to the following projects and their maintainers:
|
|
|
|
### Core Technology
|
|
- [whisper.cpp](https://github.com/ggerganov/whisper.cpp) - High-performance inference of OpenAI's Whisper model
|
|
|
|
### Essential Dependencies
|
|
- [Sparkle](https://github.com/sparkle-project/Sparkle) - Keeping VoiceInk up to date
|
|
- [HotKey](https://github.com/soffes/HotKey) - Global shortcut support
|
|
- [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts) - User-customizable keyboard shortcuts
|
|
- [Defaults](https://github.com/sindresorhus/Defaults) - Modern user defaults management
|
|
- [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin) - Launch at login functionality
|
|
|
|
### Community
|
|
- All contributors who help make this project better
|
|
- The open-source community for their invaluable tools and support
|
|
|
|
---
|
|
|
|
Made with ❤️ by the VoiceInk team |