72 lines (56 loc) · 3.12 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

Comprehensive documentation in README.md covering design, data flows, and API integrations
Development guide (DEVELOPMENT.md) with detailed technical information
Project description and metadata in flake.nix
Enhanced package structure with proper versioning and metadata

Changed

BREAKING: Updated Python version from 3.10 to 3.12 in flake.nix
Updated nixpkgs dependency to more recent commit (2024-08-20)
Updated flake-utils dependency to more recent version
Improved package structure in flake.nix with proper naming and metadata
Enhanced README with detailed architecture documentation, troubleshooting, and usage examples

Technical Details

Dependency Updates

nixpkgs: Updated from 09ec6a0881e1a36c29d67497693a67a16f4da573 (2023-12-04) to c374d94f1536013ca8e92341b540eba4c22f9c62 (2024-08-20)
flake-utils: Updated from 4022d587cbbfd70fe950c1e2083a02621806a725 to b1d9ab70662946ef0850d488da1c9019f3a9752a
Python: Upgraded from 3.10 to 3.12 for better performance and newer language features

Package Improvements

Renamed package from generic "defaultPackage" to "whisper-input"
Added proper versioning (1.0.0)
Added comprehensive metadata including description, homepage, license
Improved installation structure with dedicated share directory
Enhanced executable script with argument passing support

Documentation Enhancements

README.md: Complete rewrite with architecture overview, data flow diagrams, API documentation, setup instructions, and troubleshooting guide
DEVELOPMENT.md: New comprehensive developer guide covering project structure, development environment, testing strategies, and contribution workflow
Code Documentation: Improved inline documentation and examples

Migration Notes

For Users

No breaking changes to the command-line interface
Same usage patterns and arguments
Improved performance with Python 3.12

For Developers

Update development environment: nix develop will now use Python 3.12
Package structure has changed: built artifacts now in share/whisper-input/
New documentation files available for reference

For Package Maintainers

Package name changed from "defaultPackage" to "whisper-input"
Added proper metadata for package managers
Improved installation paths and structure

Compatibility

Backward Compatible: All existing command-line arguments and behavior preserved
Platform Support: Maintained support for all Unix-like platforms
Dependency Compatibility: All Python packages remain compatible with Python 3.12

[1.0.0] - 2023-12-04

Initial Release

Basic speech-to-text functionality using OpenAI Whisper
PyAudio integration for microphone input
Automatic silence detection
Desktop notifications for user feedback
Cross-platform keyboard simulation
Nix flake packaging for reproducible builds