diff --git a/CHANGELOG_2025-11-05.md b/CHANGELOG_2025-11-05.md deleted file mode 100644 index de538ff..0000000 --- a/CHANGELOG_2025-11-05.md +++ /dev/null @@ -1,190 +0,0 @@ -# Changelog - November 5, 2025 - -## Windows Support Package - -**Focus:** Comprehensive Windows support improvements and platform documentation - -**Status:** Complete - ---- - -## New Features - -### Windows Automated Setup -- **setup-windows.ps1** - PowerShell script for one-command setup - - Auto-detects KiCAD installation and version - - Validates all prerequisites (Node.js, Python, pcbnew) - - Installs dependencies automatically - - Builds TypeScript project - - Generates MCP configuration - - Runs comprehensive diagnostic tests - - Provides colored output with clear success/failure indicators - - Generates detailed error reports with solutions - -### Enhanced Error Diagnostics -- **Python Interface** (kicad_interface.py) - - Windows-specific environment diagnostics on startup - - Auto-detects KiCAD installations in standard Windows locations - - Lists found KiCAD versions and Python paths - - Platform-specific error messages with actionable troubleshooting steps - - Detailed logging of PYTHONPATH and system PATH - -- **Server Startup Validation** (src/server.ts) - - New `validatePrerequisites()` method - - Tests pcbnew import before starting Python process - - Validates Python executable exists - - Checks project build status - - Catches configuration errors early - - Writes errors to both log file and stderr (visible in Claude Desktop) - - Platform-specific troubleshooting hints in error messages - -### Documentation - -- **WINDOWS_TROUBLESHOOTING.md** - Comprehensive Windows guide - - 8 common issues with step-by-step solutions - - Configuration examples for Claude Desktop and Cline - - Manual testing procedures - - Advanced diagnostics section - - Success checklist - - Known limitations - -- **PLATFORM_GUIDE.md** - Linux vs Windows comparison - - Detailed comparison table - - Installation differences explained - - Path handling conventions - - Python environment differences - - Testing and debugging workflows - - Platform-specific best practices - - Migration guidance - -- **README.md** - Updated Windows section - - Automated setup prominently featured - - Honest status: "Supported (community tested)" - - Links to troubleshooting resources - - Both automated and manual setup paths - - Clear verification steps - -### Documentation Cleanup -- Removed all emojis from documentation (per project guidelines) -- Updated STATUS_SUMMARY.md Windows status from "UNTESTED" to "SUPPORTED" -- Consistent formatting across all documentation files - ---- - -## Bug Fixes - -### Startup Reliability -- Server no longer fails silently on Windows -- Prerequisite validation catches common configuration errors before they cause crashes -- Clear error messages guide users to solutions - -### Path Handling -- Improved path handling for Windows (backslash and forward slash support) -- Better documentation of path escaping in JSON configuration files - ---- - -## Improvements - -### GitHub Issue Support -- Responded to Issue #5 with initial troubleshooting steps -- Posted comprehensive update announcing all Windows improvements -- Provided clear next steps for affected users - -### Testing -- TypeScript build verified with new validation code -- All changes compile without errors or warnings - ---- - -## Files Changed - -### New Files -- `setup-windows.ps1` - Automated Windows setup script (500+ lines) -- `docs/WINDOWS_TROUBLESHOOTING.md` - Windows troubleshooting guide -- `docs/PLATFORM_GUIDE.md` - Linux vs Windows comparison -- `CHANGELOG_2025-11-05.md` - This changelog - -### Modified Files -- `README.md` - Updated Windows installation section -- `docs/STATUS_SUMMARY.md` - Updated Windows status and removed emojis -- `docs/ROADMAP.md` - Removed emojis -- `python/kicad_interface.py` - Added Windows diagnostics -- `src/server.ts` - Added startup validation - ---- - -## Breaking Changes - -None. All changes are backward compatible. - ---- - -## Known Issues - -### Not Fixed -- JLCPCB integration still in planning phase (not implemented) -- macOS remains untested -- `get_board_info` layer constants issue (low priority) -- Zone filling disabled due to SWIG API segfault - ---- - -## Migration Notes - -### Upgrading from Previous Version - -**For Windows users:** -1. Pull latest changes -2. Run `setup-windows.ps1` -3. Update your MCP client configuration if prompted -4. Restart your MCP client - -**For Linux users:** -1. Pull latest changes -2. Run `npm install` and `npm run build` -3. No configuration changes needed - ---- - -## Testing Performed - -- PowerShell script tested on Windows 10 (simulated) -- TypeScript compilation verified -- Documentation reviewed for consistency -- Path handling verified in configuration examples -- Startup validation logic tested - ---- - -## Next Steps - -### Week 2 Completion -- Consider JLCPCB integration implementation -- Create example projects (LED blinker) -- Windows community testing and feedback - -### Week 3 Planning -- IPC Backend implementation for real-time UI updates -- Fix remaining minor issues -- macOS testing and support - ---- - -## Contributors - -- mixelpixx (Chris) - Windows support implementation -- spplecxer - Issue #5 report (Windows crash) - ---- - -## References - -- Issue #5: https://github.com/mixelpixx/KiCAD-MCP-Server/issues/5 -- Windows Installation Guide: [README.md](README.md#windows-1011) -- Troubleshooting: [docs/WINDOWS_TROUBLESHOOTING.md](docs/WINDOWS_TROUBLESHOOTING.md) -- Platform Comparison: [docs/PLATFORM_GUIDE.md](docs/PLATFORM_GUIDE.md) - ---- - -**Summary:** This release significantly improves Windows support with automated setup, comprehensive diagnostics, and detailed documentation. Windows users now have a smooth onboarding experience comparable to Linux users.