Fastest and only macOS Dictation app with on-device STT and custom trained AI enhancement model. Windows, iOS testflight! Android, Linux waitlist open! A local Wispr Flow alternative. Follow https://x.com/fluidvoiceapp for more
Simplify documentation for initial open source release
grohith327ecb786d69c43
diff --git a/CHANGELOG.md b/CHANGELOG.mddeleted file mode 100644index 1f8242a4..00000000--- a/CHANGELOG.md+++ /dev/null@@ -1,107 +0,0 @@-# Changelog--All notable changes to Fluid will be documented in this file.--The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),-and this project adheres to [Semantic Versioning](https://semverversioning.org/spec/v2.0.0.html).--## [Unreleased]--### Added-- Comprehensive documentation for all major classes and methods-- MIT license file-- Contributing guidelines for open source collaboration-- README with detailed setup and usage instructions-- .gitignore file for proper version control-- Custom model repository configuration options--### Changed-- Made hardcoded model repository configurable via constructor parameters-- Improved error handling with detailed documentation-- Enhanced code documentation throughout the codebase-- Updated project structure for better organization--### Fixed-- Removed hardcoded sensitive information (usernames, API endpoints)-- Added proper error handling for audio session failures-- Improved thread safety with @MainActor annotations--## [2.1.0] - 2025-01-XX--### Added-- Enhanced audio visualization with customizable noise thresholds-- Improved accessibility support with better keyboard navigation-- Advanced debugging capabilities with structured logging-- Performance optimizations for real-time audio processing--### Changed-- Refactored audio processing pipeline for better performance-- Updated UI components with modern SwiftUI patterns-- Improved model management with automatic caching--### Fixed-- Fixed memory leaks in audio processing-- Resolved accessibility permission handling issues-- Fixed transcription accuracy issues in noisy environments--## [2.0.0] - 2024-12-XX--### Added-- AI processing integration with OpenAI-compatible APIs-- Model management system with automatic downloads-- Advanced audio visualization with real-time feedback-- Global hotkey system with customizable shortcuts-- Settings management with persistent preferences--### Changed-- Complete rewrite of ASR service with modern architecture-- Improved UI with SwiftUI and modern design patterns-- Enhanced error handling and user feedback-- Updated to support latest macOS features--### Fixed-- Fixed audio device detection and switching-- Resolved memory management issues-- Improved transcription accuracy and reliability--## [1.0.0] - 2024-07-XX--### Added-- Basic dictation functionality with real-time transcription-- Menu bar integration-- Simple audio capture and processing-- Basic text insertion capabilities--## [0.1.0] - 2024-01-XX--### Added-- Initial prototype with basic speech recognition-- Proof of concept for macOS dictation-- Core audio processing framework integration-------## Versioning--Fluid follows semantic versioning:--- **Major version** (x.0.0): Breaking changes or major new features-- **Minor version** (x.y.0): New features, backward compatible-- **Patch version** (x.y.z): Bug fixes, backward compatible--## Release Process--1. Update version number in project settings-2. Update this changelog with changes since last release-3. Tag the release with the version number-4. Create release notes with key features and fixes--## Contributing--When contributing to this project, please update the changelog with your changes:--- Add new features to the "Added" section-- Document breaking changes in "Changed" section-- List bug fixes in the "Fixed" section--For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mddeleted file mode 100644index 3db1bf1c..00000000--- a/CONTRIBUTING.md+++ /dev/null@@ -1,248 +0,0 @@-# Contributing to Fluid--Thank you for your interest in contributing to Fluid! We welcome contributions from the community and are excited to collaborate with developers who share our passion for building exceptional macOS applications.--## 🚀 Quick Start--1. **Fork** the repository-2. **Clone** your fork: `git clone https://github.com/your-username/fluid-dictation.git`-3. **Create** a feature branch: `git checkout -b feature/amazing-feature`-4. **Make** your changes following our guidelines-5. **Test** your changes thoroughly-6. **Submit** a pull request--## 📋 Contribution Guidelines--### Code Standards--#### Swift Style Guide-- Follow [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/)-- Use descriptive variable and function names-- Prefer `let` over `var` when possible-- Add comprehensive documentation for public APIs-- Include error handling for all fallible operations--#### Naming Conventions-```swift-// ✅ Good-class SpeechRecognitionService {- func transcribe(audioData: Data) async throws -> String-}--// ❌ Avoid-class SpeechService {- func transcribeAudio(data: Data) -> String-}-```--#### Documentation-- Add documentation comments for all public classes, methods, and properties-- Use clear, concise language-- Include parameter descriptions and return value explanations-- Add examples when helpful--```swift-/// Handles speech recognition with real-time transcription capabilities.-/// - Parameter audioData: Raw audio data in PCM format-/// - Returns: Transcribed text from the audio-/// - Throws: `ASRServiceError` if transcription fails-public func transcribe(audioData: Data) async throws -> String-```--### Testing Requirements--#### Unit Tests-- Add unit tests for new functionality-- Test both success and error scenarios-- Mock external dependencies when possible-- Aim for 80%+ code coverage for new features--#### Integration Tests-- Test integration with system APIs (Accessibility, Audio)-- Verify functionality across different macOS versions-- Test with various input devices and configurations--#### Manual Testing Checklist-- [ ] Test with different microphones-- [ ] Verify global hotkey functionality-- [ ] Check text insertion in multiple applications-- [ ] Test AI integration (if applicable)-- [ ] Validate accessibility permissions-- [ ] Test with different audio environments (quiet/noisy)--### Pull Request Process--#### Before Submitting-1. **Test thoroughly** - Ensure your changes work as expected-2. **Update documentation** - Add or update README if needed-3. **Add tests** - Include unit and integration tests-4. **Check formatting** - Use consistent code style-5. **Review changes** - Double-check your implementation--#### PR Template-```markdown-## Description-[Brief description of changes]--## Type of Change-- [ ] Bug fix-- [ ] New feature-- [ ] Breaking change-- [ ] Documentation update--## Testing-- [ ] Added unit tests-- [ ] Tested manually on macOS [version]-- [ ] Verified with different input devices--## Screenshots-[Add screenshots if UI changes are involved]--## Related Issues-Closes #123--## Checklist-- [ ] Follows code style guidelines-- [ ] Tests added/updated-- [ ] Documentation updated-- [ ] Accessibility considered-- [ ] Performance impact assessed-```--### Development Workflow--#### Branch Naming-```-feature/descriptive-feature-name-bugfix/issue-number-description-hotfix/critical-fix-description-docs/update-documentation-```--#### Commit Messages-Use conventional commit format:-```-feat: add new speech recognition model support-fix: resolve crash when accessibility permissions denied-docs: update API documentation for AI providers-test: add unit tests for audio processing-```--## 🛠️ Development Setup--### Prerequisites-- **macOS 12.0+**-- **Xcode 14.0+**-- **Swift 5.7+**--### Local Development-1. Clone the repository-2. Open `dictate_v2.xcodeproj` in Xcode-3. Build the project (`Cmd + B`)-4. Run tests (`Cmd + U`)--### Debugging Tips-- Enable debug logging in Settings → Debug Settings-- Use Xcode's debugging tools (breakpoints, console)-- Check system logs for accessibility-related issues-- Test with different audio input sources--## 🎯 Feature Development--### Adding New AI Providers-1. Implement the `AIProvider` protocol-2. Add to the provider selection UI-3. Include configuration options-4. Add tests for the new provider--### Custom ASR Models-1. Update `HuggingFaceModelDownloader` configuration-2. Test model compatibility-3. Update documentation-4. Add fallback handling--### UI Enhancements-1. Follow SwiftUI design patterns-2. Consider accessibility features-3. Test on different screen sizes-4. Maintain consistent visual style--## 🔒 Security Considerations--### API Keys and Credentials-- Never commit API keys to the repository-- Use environment variables for sensitive data-- Document secure configuration procedures-- Validate input from external sources--### Privacy-- Respect user privacy preferences-- Handle personal data securely-- Follow macOS privacy guidelines-- Document data collection and usage--## 📱 macOS-Specific Guidelines--### Accessibility-- Use proper accessibility labels-- Support keyboard navigation-- Test with VoiceOver-- Follow Apple accessibility guidelines--### System Integration-- Handle permission requests gracefully-- Provide clear error messages-- Support system dark mode-- Follow macOS human interface guidelines--### Performance-- Minimize CPU usage during idle periods-- Efficient memory management-- Optimize audio processing-- Profile performance regularly--## 🤝 Code Review Process--### What We Look For-- **Code quality**: Clean, readable, maintainable code-- **Functionality**: Does it work as intended?-- **Testing**: Comprehensive test coverage-- **Documentation**: Clear and complete-- **Security**: No security vulnerabilities-- **Performance**: Efficient and optimized--### Review Checklist-- [ ] Code follows project style guidelines-- [ ] Functionality works as described-- [ ] Tests are included and passing-- [ ] Documentation is updated-- [ ] No breaking changes without discussion-- [ ] Performance impact assessed-- [ ] Security considerations addressed--## 📞 Communication--### Getting Help-- **Issues**: Use GitHub Issues for bug reports and feature requests-- **Discussions**: Use GitHub Discussions for questions and ideas-- **Email**: For private communications--### Response Times-- **Issues**: We aim to respond within 2-3 business days-- **Pull Requests**: Reviews typically completed within 1 week-- **Security Issues**: Addressed immediately--## 🎉 Recognition--We love to recognize our contributors! Contributors who make significant improvements will be:-- Mentioned in release notes-- Added to the acknowledgments section-- Featured in community updates--## 📄 License--By contributing to Fluid, you agree that your contributions will be licensed under the same license as the original project (MIT License).-------Thank you for contributing to Fluid! Your efforts help make dictation technology more accessible and powerful for everyone. 🚀diff --git a/ERROR_HANDLING.md b/ERROR_HANDLING.mddeleted file mode 100644index 9ef2f2f5..00000000--- a/ERROR_HANDLING.md+++ /dev/null@@ -1,326 +0,0 @@-# Error Handling Guide--This document outlines the comprehensive error handling strategy used in Fluid, ensuring robust operation across various failure scenarios.--## Overview--Fluid implements a multi-layered error handling approach:--1. **Silent Failures**: Non-critical operations that fail gracefully-2. **User Notifications**: Important errors that require user attention-3. **Debug Logging**: Detailed error information for troubleshooting-4. **Recovery Mechanisms**: Automatic error recovery where possible--## Error Categories--### 1. Permission Errors--#### Microphone Access-```swift-func requestMicAccess() {- AVCaptureDevice.requestAccess(for: .audio) { [weak self] granted in- Task { @MainActor in- self?.micStatus = granted ? .authorized : .denied- if !granted {- // Show user notification about microphone access- self?.showMicPermissionError()- }- }- }-}-```--**Handling Strategy:**-- Request permission on first use-- Provide clear instructions for manual permission granting-- Gracefully disable features that require microphone access-- Show helpful error messages with links to System Settings--#### Accessibility Permissions-```swift-private func requestAccessibilityPermissions() {- guard !AXIsProcessTrusted() else { return }-- let options = [kAXTrustedCheckOptionPrompt.takeUnretainedValue() as String: true] as CFDictionary- AXIsProcessTrustedWithOptions(options)-- // Deep link to Accessibility settings if still not trusted- DispatchQueue.main.asyncAfter(deadline: .now() + 1.2) {- guard !AXIsProcessTrusted(),- let url = URL(string: "x-apple.systempreferences:com.apple.preference.security?Privacy_Accessibility")- else { return }- NSWorkspace.shared.open(url)- }-}-```--**Handling Strategy:**-- Request permissions during app initialization-- Provide automatic deep-linking to System Settings-- Show clear error messages explaining why permissions are needed-- Disable hotkey functionality if permissions are denied--### 2. Audio Processing Errors--#### Audio Engine Failures-```swift-func startEngine() throws {- var attempts = 0- while attempts < 3 {- do {- try engine.start()- return- } catch {- attempts += 1- Thread.sleep(forTimeInterval: 0.1)- engine.reset()- }- }- throw NSError(domain: "ASRService", code: -1, userInfo: [NSLocalizedDescriptionKey: "Failed to start audio engine"])-}-```--**Handling Strategy:**-- Retry mechanism with exponential backoff-- Automatic engine reset on failures-- Clear error messages for user feedback-- Graceful degradation of functionality--#### Device Detection Errors-```swift-private func handleDefaultInputChanged() {- if isRunning {- removeEngineTap()- engine.stop()- do {- try configureSession()- try startEngine()- setupEngineTap()- } catch {- // Log error but don't show to user - audio should continue working- DebugLogger.shared.warning("Failed to restart audio engine after device change: \(error)", source: "ASRService")- }- }-}-```--**Handling Strategy:**-- Silent recovery attempts-- Detailed logging for debugging-- No user interruption during recovery--### 3. Model Management Errors--#### Download Failures-```swift-func ensureModelsPresent(at targetRoot: URL, onProgress: ((Double, String) -> Void)? = nil) async throws {- try FileManager.default.createDirectory(at: targetRoot, withIntermediateDirectories: true)-- var pendingFiles: [String] = []- for item in requiredItems() {- // Check existing files and build download list- // ... implementation details ...- }-- // Download with progress tracking and error handling- for (idx, rel) in pendingFiles.enumerated() {- try await downloadFile(relativePath: rel, to: targetRoot.appendingPathComponent(rel)) { perFilePct in- // Progress callback with error handling- }- }-}-```--**Handling Strategy:**-- Comprehensive progress tracking-- Detailed error reporting-- Automatic retry for network failures-- Clear user feedback about download status--#### Model Loading Errors-```swift-func ensureAsrReady() async throws {- if isAsrReady == false {- do {- // Download models if needed- let downloader = HuggingFaceModelDownloader()- try await downloader.ensureModelsPresent(at: cacheDir) { progress, item in- DispatchQueue.main.async {- self.isDownloadingModel = progress < 1.0- self.modelDownloadProgress = max(0.0, min(1.0, progress))- }- }-- // Load models with error handling- let models = try await downloader.loadLocalAsrModels(from: cacheDir)-- if self.asrManager == nil {- self.asrManager = AsrManager(config: ASRConfig(realtimeMode: false))- }-- if let manager = self.asrManager {- try await manager.initialize(models: models)- }-- isAsrReady = true- } catch {- DebugLogger.shared.error("ASR initialization failed: \(error)", source: "ASRService")- throw error- }- }-}-```--**Handling Strategy:**-- Detailed error logging with context-- Proper error propagation-- User-friendly error messages-- Graceful fallback when models can't be loaded--### 4. Text Injection Errors--#### Accessibility API Failures-```swift-private func tryAllTextInsertionMethods(_ element: AXUIElement, _ text: String) -> Bool {- // Try multiple approaches for text insertion- if setTextViaValue(element, text) {- return true- }-- if setTextViaSelection(element, text) {- return true- }-- if insertTextAtInsertionPoint(element, text) {- return true- }-- return false-}-```--**Handling Strategy:**-- Multiple fallback strategies-- Detailed logging for each attempt-- Graceful degradation when insertion fails-- User notification for repeated failures--#### CGEvent Failures-```swift-private func insertTextBulkInstant(_ text: String) -> Bool {- guard let event = CGEvent(keyboardEventSource: nil, virtualKey: 0, keyDown: true) else {- DebugLogger.shared.error("Failed to create bulk CGEvent", source: "TypingService")- return false- }-- let utf16Array = Array(text.utf16)- event.keyboardSetUnicodeString(stringLength: utf16Array.count, unicodeString: utf16Array)- event.post(tap: .cghidEventTap)-- return true-}-```--**Handling Strategy:**-- Fallback to character-by-character typing-- Detailed error logging-- No user interruption for failed attempts--## Error Recovery Mechanisms--### Automatic Recovery-- **Audio Device Changes**: Automatic restart of audio engine-- **Network Failures**: Retry mechanism for model downloads-- **Permission Changes**: Automatic reinitialization when permissions granted--### User-Initiated Recovery-- **Retry Buttons**: For failed operations-- **Manual Configuration**: Settings for troubleshooting-- **Diagnostic Tools**: Debug mode with detailed logging--## User Feedback Strategy--### Error Messages-```swift-// Example error message format-"Unable to access microphone. Please grant microphone permission in System Settings → Privacy & Security → Microphone, then restart Fluid."-```--### Visual Indicators-- **Progress Bars**: For long-running operations-- **Status Icons**: Color-coded status indicators-- **Toast Notifications**: Non-intrusive error messages-- **Loading States**: Clear indication of operation status--### Debug Information-- **Console Logs**: Detailed technical information-- **Debug Settings**: Enable/disable debug features-- **Export Logs**: Ability to export logs for support--## Best Practices--### 1. Fail Gracefully-```swift-do {- try riskyOperation()-} catch {- // Log detailed error information- DebugLogger.shared.error("Operation failed: \(error)", source: "Component")-- // Show user-friendly message- showUserFriendlyError()-- // Attempt recovery if possible- attemptRecovery()-}-```--### 2. Provide Context-```swift-DebugLogger.shared.error("ASR transcription failed during model initialization", source: "ASRService")-```--### 3. Use Appropriate Error Levels-- **Debug**: Detailed technical information-- **Info**: General operational information-- **Warning**: Non-critical issues that should be addressed-- **Error**: Critical failures requiring attention--### 4. Recovery Mechanisms-```swift-func attemptRecovery() {- // Retry with backoff- // Fallback to alternative approach- // Disable problematic features gracefully-}-```--## Testing Error Scenarios--### Unit Tests-- Test error handling for all major components-- Verify recovery mechanisms work correctly-- Test with mocked dependencies--### Integration Tests-- Test with real hardware (microphones, displays)-- Verify accessibility API behavior-- Test network failure scenarios--### Manual Testing-- Test with denied permissions-- Simulate network failures-- Test with various audio environments-- Verify error messages are helpful--## Conclusion--Fluid's error handling strategy ensures a robust, user-friendly experience by:--1. **Graceful Degradation**: Features fail gracefully without crashing-2. **Clear Communication**: Users understand what went wrong and how to fix it-3. **Automatic Recovery**: Many issues resolve themselves automatically-4. **Detailed Debugging**: Developers have comprehensive information for troubleshooting-5. **User Control**: Advanced users can access diagnostic tools and detailed logs--This approach balances technical robustness with user experience, making Fluid reliable for both casual and professional users.diff --git a/README.md b/README.mdindex 65ffcbd4..ff973b50 100644--- a/README.md+++ b/README.md@@ -1,267 +1,28 @@-# Fluid - Advanced macOS Dictation App+# Fluid-[](https://opensource.org/licenses/MIT)-[](https://developer.apple.com/macos/)+Voice-to-text dictation app for macOS with AI enhancement.-Fluid is a sophisticated macOS dictation application that transforms speech into text with real-time transcription capabilities. Built with Swift and SwiftUI, it provides professional-grade speech recognition with AI enhancement features.+## Features-## ✨ Features+- Real-time voice transcription using Parakeet TDT v3+- AI-powered text enhancement+- Global hotkey support+- Multi-language support+- Auto-updates-- **Real-time Speech Recognition**: Instant transcription with minimal latency-- **Global Hotkey Support**: Start/stop recording with customizable keyboard shortcuts-- **AI Processing**: Enhance transcriptions with OpenAI-compatible APIs-- **Audio Visualization**: Real-time visual feedback during recording-- **Multi-App Support**: Seamlessly type into any application-- **Model Management**: Automatic downloading and management of ASR models-- **Accessibility Integration**: Full support for macOS accessibility features-- **Menu Bar Integration**: Non-intrusive menubar app design+## Requirements-## 🚀 Installation+- macOS 13.0 or later+- Microphone access-### Prerequisites+## Building-- **macOS 12.0** or later-- **Xcode 14.0** or later-- **Swift 5.7** or later-- **Developer Tools** (install via Xcode)+Open `Fluid.xcodeproj` in Xcode and build.-### Build Instructions+## License-1. **Clone the repository**- ```bash- git clone <repository-url>- cd fluid-dictation- ```--2. **Install dependencies**- ```bash- # The project uses Swift Package Manager- # Dependencies are automatically resolved by Xcode- ```--3. **Open in Xcode**- ```bash- open Fluid.xcodeproj- ```--4. **Build and Run**- - Select the `Fluid` scheme- - Build with `Cmd + B`- - Run with `Cmd + R`--## ⚙️ Configuration--### Model Repository--By default, Fluid uses optimized ASR models from Hugging Face. You can customize the model repository:--```swift-let downloader = HuggingFaceModelDownloader(- owner: "your-username",- repo: "your-model-repository",- revision: "main"-)-```--### API Configuration--Configure AI providers in the settings:--1. Open Fluid-2. Go to Settings → AI Prompts-3. Add your API credentials for supported providers--**Supported Providers:**-- OpenAI (GPT-4, GPT-3.5)-- OpenAI-compatible APIs (Azure OpenAI, Local models, etc.)-- Custom endpoints--### Global Hotkey--Set up a global keyboard shortcut:--1. Open Fluid-2. Go to Settings → General-3. Click "Record Shortcut" and press your desired key combination-4. Default: `Right Option` key--## 🎯 Usage--### Basic Dictation--1. **Start Recording**: Press your configured global hotkey or use the menu bar-2. **Speak**: The app will show visual feedback and transcribe your speech-3. **Stop Recording**: Press the hotkey again or use the menu bar-4. **Text Insertion**: Transcribed text is automatically typed into the focused application--### AI Enhancement--Enable AI processing to enhance your transcriptions:--1. Enable "AI Processing" in Settings-2. Configure your AI provider and API key-3. Create custom prompts for different use cases-4. Transcribed text will be processed through your AI model before insertion--### Audio Settings--Adjust audio processing parameters:--- **Input Device**: Choose your microphone-- **Noise Threshold**: Adjust sensitivity for audio visualization-- **Audio Visualization**: Customize the visual feedback display--## 🏗️ Architecture--### Core Components--- **ASRService**: Handles speech recognition and model management-- **TypingService**: Manages text insertion across applications-- **GlobalHotkeyManager**: Manages system-wide keyboard shortcuts-- **MenuBarManager**: Controls the menubar integration-- **SettingsStore**: Persists user preferences and configuration-- **DebugLogger**: Provides structured logging for troubleshooting--### Key Technologies--- **FluidAudio**: Advanced speech recognition framework-- **CoreML**: On-device machine learning for model inference-- **AVFoundation**: Audio capture and processing-- **Accessibility API**: System integration for text insertion-- **SwiftUI**: Modern user interface framework--## 🔧 Development--### Project Structure--```-fluid-dictation/-├── Sources/Fluid/ # Main application source code-│ ├── Assets.xcassets/ # App icons and resources-│ ├── Services/ # Core service classes-│ │ ├── ASRService.swift # Speech recognition service-│ │ ├── TypingService.swift # Text insertion service-│ │ ├── GlobalHotkeyManager.swift-│ │ └── ...-│ ├── Networking/ # API and model management-│ │ ├── AIProvider.swift # AI integration protocols-│ │ └── ModelDownloader.swift # Hugging Face model management-│ ├── Persistence/ # Data persistence-│ │ └── SettingsStore.swift # User preferences-│ ├── Models/ # Data models-│ │ └── HotkeyShortcut.swift # Keyboard shortcut model-│ ├── UI/ # User interface components-│ ├── ContentView.swift # Main application view-│ └── fluidApp.swift # App entry point-├── Fluid.xcodeproj/ # Xcode project-├── LICENSE # MIT license-├── README.md # This file-├── CONTRIBUTING.md # Contribution guidelines-└── ERROR_HANDLING.md # Error handling documentation-```--### Building Custom Models--To use custom ASR models:--1. Upload your model to Hugging Face-2. Update the repository configuration in `ModelDownloader.swift`-3. The app will automatically download and use your custom models--### Debugging--Enable debug logging for development:--1. Go to Settings → Debug Settings-2. Enable "Debug Logging"-3. Check the console for detailed logs--## 🧪 Testing--### Unit Tests--```bash-# Run tests in Xcode-# Product → Test (Cmd + U)-```--### Manual Testing--- Test with different audio input devices-- Verify global hotkey functionality-- Test AI integration with various providers-- Validate text insertion across different applications--## 🤝 Contributing--We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.--### Development Setup--1. Fork the repository-2. Create a feature branch-3. Make your changes-4. Add tests for new functionality-5. Submit a pull request--### Code Style--- Follow Swift API Design Guidelines-- Use meaningful variable and function names-- Add comprehensive documentation-- Include error handling for all operations--## 📝 License--This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.--## 🙏 Acknowledgments--- **FluidAudio** framework for advanced speech recognition-- **Apple** for macOS accessibility APIs-- **OpenAI** for AI integration standards-- **Hugging Face** for model hosting infrastructure--## 🐛 Troubleshooting--### Common Issues--**Accessibility permissions not granted:**-- Go to System Settings → Privacy & Security → Accessibility-- Enable Fluid in the list of allowed applications--**Microphone not detected:**-- Check System Settings → Privacy & Security → Microphone-- Ensure Fluid has microphone access--**AI processing not working:**-- Verify API key is correctly configured-- Check network connectivity-- Validate provider endpoint URL--**Global hotkey not responding:**-- Ensure no other application is using the same shortcut-- Check accessibility permissions-- Try restarting the application--### Getting Help--- Check the debug logs (Settings → Debug Settings)-- Review the troubleshooting section-- Create an issue on GitHub with detailed information--## 🔄 Updates--### Version History--- **v1.0**: Initial release with basic dictation-- **v2.0**: Added AI processing and model management-- **v2.1**: Enhanced audio visualization and accessibility--### Release Notes--For detailed release information, see [CHANGELOG.md](CHANGELOG.md).+Same as Parakeet TDT v3----**Made with ❤️ for the macOS community**+⭐ Star this repo if you find it useful and want to support development!\ No newline at end of filediff --git a/RELEASE_GUIDE.md b/RELEASE_GUIDE.mddeleted file mode 100644index 24fa6da4..00000000--- a/RELEASE_GUIDE.md+++ /dev/null@@ -1,228 +0,0 @@-# 🚀 Fluid App Release Guide - Complete End-to-End Setup--This guide covers everything you need to know to set up automatic updates for your Fluid dictation app.--## 📋 **Current Configuration**--- **GitHub Repository**: `https://github.com/altic-dev/fluid`-- **Owner**: `altic-dev`-- **Repository Name**: `fluid`-- **Current Version**: `1.1` (as set in Info.plist)--## 🔧 **1. AppUpdater Setup (Already Done!)**--✅ **AppUpdater Integration Complete**:-- Added as Swift Package dependency-- Configured in AppDelegate with automatic daily checks-- Manual update check available in menu bar-- Error handling and user notifications implemented--## 📦 **2. Building and Packaging Your App**--### **Build Steps:**-1. **Set Release Configuration**:- ```bash- # In Xcode, change scheme to "Release" mode- # Or via command line:- xcodebuild -project Fluid.xcodeproj -scheme Fluid -configuration Release clean build- ```--2. **Archive Your App**:- ```bash- # Create an archive- xcodebuild -project Fluid.xcodeproj -scheme Fluid -configuration Release archive -archivePath build/Fluid.xcarchive-- # Export the app- xcodebuild -exportArchive -archivePath build/Fluid.xcarchive -exportPath build/Release -exportOptionsPlist ExportOptions.plist- ```--3. **Create Release ZIP**:- ```bash- # Navigate to your exported app- cd build/Release-- # Create zip with EXACT naming convention- zip -r fluid-1.1.zip Fluid.app- ```--## 🎯 **3. GitHub Release Setup**--### **Critical Requirements:**--#### **A. Asset Naming Convention**-AppUpdater expects this EXACT format:-```-{repo-name}-{version}.{extension}-```--**Examples:**-- ✅ `fluid-1.1.zip`-- ✅ `fluid-1.2.zip`-- ✅ `fluid-2.0.zip`-- ❌ `Fluid-1.1.zip` (wrong case)-- ❌ `fluid-v1.1.zip` (extra 'v')-- ❌ `fluid_1.1.zip` (underscore instead of dash)--#### **B. Version Matching**-The release tag must match your `CFBundleShortVersionString` in Info.plist:--**Info.plist:**-```xml-<key>CFBundleShortVersionString</key>-<string>1.1</string>-```--**GitHub Release Tag:**-```-v1.1 (recommended)-or-1.1 (also works)-```--### **Creating a Release:**--1. **Go to your repository**: `https://github.com/altic-dev/fluid/releases`--2. **Click "Create a new release"**--3. **Fill out the release:**- ```- Tag: v1.1- Title: Fluid v1.1 - Parakeet TDT v3 with Multi-Language Support- Description:- ## 🎉 What's New in v1.1-- - **Upgraded to Parakeet TDT v3** with unified model architecture- - **25 European languages** with auto-detection support- - **Enhanced UI** with language selection and documentation links- - **Improved error handling** and logging- - **Automatic updates** - this is the first version with auto-update capability!-- ## 🚀 Installation- 1. Download `fluid-1.1.zip`- 2. Extract and move `Fluid.app` to your Applications folder- 3. Run the app and grant accessibility permissions when prompted-- ## 🔧 System Requirements- - macOS 13.0 or later- - Apple Silicon or Intel Mac- ```--4. **Upload your zip file**: Drag `fluid-1.1.zip` to the release assets--5. **Publish the release**--## 📅 **4. Future Release Process**--For version 1.2 and beyond:--### **Step 1: Update Version Numbers**-```xml-<!-- In Info.plist -->-<key>CFBundleVersion</key>-<string>2</string> <!-- Increment build number -->-<key>CFBundleShortVersionString</key>-<string>1.2</string> <!-- New version -->-```--### **Step 2: Build and Package**-```bash-# Build release version-xcodebuild -project Fluid.xcodeproj -scheme Fluid -configuration Release clean build--# Create zip with new version number-zip -r fluid-1.2.zip Fluid.app-```--### **Step 3: Create GitHub Release**-- **Tag**: `v1.2`-- **Asset**: `fluid-1.2.zip`-- **Title**: `Fluid v1.2 - [Your New Features]`--## 🔍 **5. Testing the Update System**--### **Manual Testing:**-1. Install version 1.1 on your Mac-2. Create a test release 1.2-3. Click "Check for Updates..." in the menu bar-4. Verify the update downloads and installs correctly--### **Automatic Testing:**-- AppUpdater checks daily automatically-- Users will get updates silently-- No user interaction required for updates--## ⚙️ **6. Advanced Configuration**--### **Code Signing (Recommended)**-AppUpdater verifies code signatures for security:-```bash-# Sign your app before zipping-codesign --force --deep --sign "Developer ID Application: Your Name" Fluid.app-```--### **Notarization (For Distribution)**-```bash-# Notarize for macOS Gatekeeper-xcrun notarytool submit fluid-1.1.zip --apple-id [email protected] --team-id YOUR_TEAM_ID --wait-```--## 🎯 **7. Repository Structure**--Your repository should look like this:-```-fluid/-├── Sources/-├── Info.plist-├── README.md-├── RELEASE_GUIDE.md ← This file-└── releases/- ├── v1.1/- │ └── fluid-1.1.zip- └── v1.2/- └── fluid-1.2.zip-```--## 🚨 **8. Troubleshooting**--### **Common Issues:**--**AppUpdater says "no updates available" but there's a new release:**-- Check asset naming: must be `fluid-{version}.zip`-- Verify version in Info.plist matches release tag-- Ensure release is published (not draft)--**Update fails to install:**-- Check code signing matches-- Verify app isn't running during update-- Check file permissions--**Manual update check doesn't work:**-- Verify AppDelegate is properly connected-- Check menu bar action is calling the right method-- Look at console logs for errors--## ✅ **9. Verification Checklist**--Before each release:-- [ ] Version updated in Info.plist-- [ ] App builds successfully in Release configuration-- [ ] Asset named correctly: `fluid-{version}.zip`-- [ ] Release tag matches Info.plist version-- [ ] Release description includes changelog-- [ ] Asset uploaded to GitHub release-- [ ] Release published (not draft)-- [ ] Manual update check tested-- [ ] App functionality verified after update--## 🎉 **Success!**--Your app now has:-- ✅ Automatic daily update checks-- ✅ Manual update checking via menu bar-- ✅ Silent update installation-- ✅ Error handling and user notifications-- ✅ Proper version management-- ✅ Complete end-to-end update pipeline--Users will now receive updates automatically without any manual intervention! 🚀