-
Notifications
You must be signed in to change notification settings - Fork 121
Fix badge links and update Homebrew command #1038
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||||||||
PR Code Suggestions ✨No code suggestions found for the PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates badge URLs and the Homebrew installation command in the README. The changes include removing the sort=semver parameter from the release badge, adding a dark theme to the star history chart, and shortening the Homebrew command from mfc run to mfc.
- Removes
sort=semverparameter from the GitHub release badge URL - Adds
theme=darkparameter to the star history chart - Simplifies Homebrew command by removing the explicit
runsubcommand
| | --- | --- | | ||
| | **Codespaces** (fastest) | Click the "Codespaces" badge above to launch in 1 click | | ||
| | **Homebrew (macOS)** | `brew install mflowcode/mfc/mfc && mfc run $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` | | ||
| | **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` | |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Homebrew command was changed from mfc run to just mfc, but this creates inconsistency with the rest of the documentation. Lines 149 in this same file, as well as docs/documentation/getting-started.md (line 26), docs/documentation/running.md (line 16), and packaging/homebrew/README.md (line 18) all use mfc run. While both forms are technically valid according to the Homebrew formula, it would be better to maintain consistency across all documentation. Consider either keeping mfc run here or updating all other locations to match.
| | **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` | | |
| | **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc run $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` | |
- Use shorthand 'mfc case.py' consistently across all documentation - Clarify that both 'mfc case.py' and 'mfc run case.py' work - Update README.md, packaging/homebrew/README.md, getting-started.md, and running.md - Improves consistency and showcases the smart detection feature Addresses Copilot AI review comment about documentation inconsistency
User description
yep
PR Type
Bug fix, Documentation
Description
Fixed badge link by removing invalid
sort=semverparameterAdded dark theme to star history chart for better visibility
Updated Homebrew installation command to use
mfcdirectlyCorrected Homebrew section header formatting
Diagram Walkthrough
File Walkthrough
README.md
Fix badges and update Homebrew commandREADME.md
sort=semverparameter from GitHub release badge URL&theme=darkparameter to star history chart API for dark themesupport
mfc runtomfcfor directexecution
parentheses
Note
Updates README badges and adjusts the Homebrew quickstart command syntax.
sort=semverparameter inhttps://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release.&theme=darktohttps://api.star-history.com/svgimage.runsubcommand:mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2.Written by Cursor Bugbot for commit 2da7f3e. Configure here.