Update README.md with new badges and platform-specific Quick Start tutorials#1
Merged
WilleIshere merged 1 commit intomainfrom Jul 4, 2025
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
🚀 Quick Start Section Rewrite
Completely restructured from 2 generic options to 3 platform-specific sections:
1. Running the Compiled Version on Windows
2. Running from Source on Windows
.venv\Scripts\activate)3. Running from Source on Linux
source .venv/bin/activate)🔄 Consistency Updates
Problem Solved
This addresses the need for:
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.