Skip to content

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 12, 2025
+3 −3
Merged

Fix badge links and update Homebrew command #1038

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@
<img src="https://img.shields.io/badge/Codespaces-Open%20in%201%20click-2ea44f?logo=github" />
</a>
<a href="https://github.com/MFlowCode/MFC/releases">
<img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release&sort=semver" />
<img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release" />
</a>
</p>

<p align="center">
<a href="https://star-history.com/#MFlowCode/MFC&Date">
<img src="https://api.star-history.com/svg?repos=MFlowCode/MFC&type=Date" alt="Star History Chart" width="600"/>
<img src="https://api.star-history.com/svg?repos=MFlowCode/MFC&type=Date&theme=dark" alt="Star History Chart" width="600"/>
</a>
</p>

Expand All @@ -60,7 +60,7 @@ MFC runs at exascale on the world's fastest supercomputers:
| Path | Command |
| --- | --- |
| **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` |
Copy link

Copilot AI Nov 12, 2025

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.

Suggested change
| **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` |

Copilot uses AI. Check for mistakes.
| **Local build** | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |

**Welcome!**
Expand Down