Skip to content

Update README.md with new badges and platform-specific Quick Start tutorials#1

Merged
WilleIshere merged 1 commit intomainfrom
copilot/fix-ad1743a5-32e3-499a-8340-75c42e3d59bf
Jul 4, 2025
Merged

Update README.md with new badges and platform-specific Quick Start tutorials#1
WilleIshere merged 1 commit intomainfrom
copilot/fix-ad1743a5-32e3-499a-8340-75c42e3d59bf

Conversation

Copy link

Copilot AI commented Jul 4, 2025

Summary

Updated the README.md to reflect the current project status with new dynamic badges and comprehensive platform-specific installation instructions, clarifying that Linux builds are not yet available.

Changes Made

🏷️ Badge Updates

  • Platform Badge: Updated to show "Windows | Linux (Source)" to clarify Linux requires source installation
  • Dynamic Release Badge: Replaced static version badge with GitHub API-powered dynamic release badge
  • Added New Badges:
    • Issues badge linking to GitHub issues
    • Stars badge linking to GitHub stargazers
    • Last commit badge showing repository activity
  • Removed: Speed badge (replaced with more meaningful metrics)
  • Enhanced: All badges now have proper links to relevant GitHub pages

🚀 Quick Start Section Rewrite

Completely restructured from 2 generic options to 3 platform-specific sections:

1. Running the Compiled Version on Windows

  • Clear step-by-step instructions
  • Prominent note that only Windows binaries are available
  • Lists required dependencies: None (everything bundled)

2. Running from Source on Windows

  • Windows-specific commands (.venv\Scripts\activate)
  • Required dependencies clearly listed: Python 3.12, UV package manager
  • Proper code blocks with comments

3. Running from Source on Linux

  • Linux-specific commands (source .venv/bin/activate)
  • Clear note that Linux builds are not yet available
  • Required dependencies clearly listed: Python 3.12, UV package manager

🔄 Consistency Updates

  • Updated Download section to reflect Linux builds unavailable
  • Updated Support section to mention Linux source installation instead of AppImage permissions
  • Updated note about compiled versions to specify "Windows version" only

Problem Solved

This addresses the need for:

  • ✅ Clear platform-specific installation instructions
  • ✅ Accurate project status badges
  • ✅ Proper highlighting of Linux build availability
  • ✅ Step-by-step tutorials with dependency requirements
  • ✅ Maintains original README style and structure

The changes make it crystal clear to users what options are available on each platform and provide the exact steps needed to get started.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@WilleIshere WilleIshere marked this pull request as ready for review July 4, 2025 06:48
@WilleIshere WilleIshere merged commit dcaf594 into main Jul 4, 2025
1 check passed
Copilot AI changed the title [WIP] Update README.md with new badges and Quick Start tutorials for Windows and Linux Update README.md with new badges and platform-specific Quick Start tutorials Jul 4, 2025
Copilot AI requested a review from WilleIshere July 4, 2025 06:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants