-
Notifications
You must be signed in to change notification settings - Fork 121
Update README.md #961
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
Update README.md #961
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
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 the README.md file to refresh badges, improve branding, and add a prominent citation section. The changes modernize the visual presentation and emphasize MFC's achievements in exascale computing.
Key Changes:
- Updated badge styling with new color schemes and improved test status display
- Added a prominent citation section with DOI and BibTeX entry for MFC 5.0
- Enhanced the welcome section with claims about the largest known open CFD simulation
| **Welcome!** | ||
| MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do). | ||
| It uses metaprogramming to stay short and portable (~20K lines). | ||
| MFC conducted the largest known, open CFD simulation at <a href="https://arxiv.org/abs/2505.07392" target="_blank">101 trillion grid points</a> (as of July 2025). |
Copilot
AI
Jul 20, 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 arXiv URL (2505.07392) does not match the DOI and citation provided later in the document (2503.07953). This inconsistency should be resolved to ensure accurate referencing.
| MFC conducted the largest known, open CFD simulation at <a href="https://arxiv.org/abs/2505.07392" target="_blank">101 trillion grid points</a> (as of July 2025). | |
| MFC conducted the largest known, open CFD simulation at <a href="https://arxiv.org/abs/2503.07953" target="_blank">101 trillion grid points</a> (as of July 2025). |
| <img src="https://img.shields.io/github/stars/MFlowCode/MFC?style=flat&color=maroon"/> | ||
| </a> | ||
|
|
||
| </br> |
Copilot
AI
Jul 20, 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.
Use <br> instead of </br> for line breaks in HTML. The closing tag syntax is incorrect for the self-closing br element.
| </br> | |
| <br> |
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||||
User description
for @henryleberre
PR Type
Documentation
Description
Update README badges with improved styling and colors
Add new citation section with DOI and BibTeX
Enhance welcome message and project description
Update supercomputer references and achievements
Diagram Walkthrough
File Walkthrough
README.md
Comprehensive README enhancement with citations and stylingREADME.md