Improve README structure and add CI workflow to sync README across variant branches

[Copilot]

This PR addresses the need for better README documentation and automated synchronization across Bluefin variant branches.

README Improvements

The README has been significantly enhanced with better structure and more comprehensive information:

• Fixed badge formatting - Added proper spacing between CI badges for better readability

• Added table of contents - Improved navigation with anchor links to all major sections

• New "Key Features" section - Comprehensive overview of Bluefin's capabilities with descriptive emojis:

  • Cloud-Native Architecture with DevOps practices
  • Immutable System with atomic updates
  • Developer-Focused tooling including Kubernetes support
  • GNOME Desktop environment
  • Secure Boot support
  • Flatpak applications
  • Performance optimization
  • Declarative management

• Enhanced "Getting Started" section - Now includes:

  • System requirements (architecture, RAM, storage, UEFI)
  • Multiple installation options (fresh install, rebase, container/VM)
  • Quick start commands for new users
  • Links to detailed documentation

CI Workflow for README Synchronization

Added .github/workflows/sync-readme.yml to automatically sync README changes to variant branches:

• Triggers: Automatically runs when README.md is modified on the main branch, plus manual dispatch support
• Target branches: yellowfin, albacore, albacore-server, bluefin-tuna, redfin
• Smart branch handling: Creates target branches if they don't exist
• Change detection: Only commits when actual changes are detected to avoid unnecessary commits
• Parallel execution: Uses matrix strategy for efficient processing of all branches
• Proper logging: Clear status messages for successful syncs and up-to-date branches

The workflow follows GitHub Actions best practices with proper error handling, Git configuration, and security measures.

Benefits

• Improved user experience - New users can quickly understand Bluefin's features and get started
• Consistent documentation - README automatically stays synchronized across all variant branches
• Reduced maintenance - No manual work needed to keep variant branch documentation current
• Better project presentation - Professional structure with clear navigation and comprehensive information

This ensures that all Bluefin variants maintain up-to-date documentation while significantly improving the overall quality and accessibility of the project's README.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.