Skip to content

Improve README formatting and add emojis #1041

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
Merged

Improve README formatting and add emojis #1041

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
26 changes: 20 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
<a href="https://github.com/MFlowCode/MFC/releases">
<img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release" />
</a>
<a href="https://github.com/MFlowCode/homebrew-mfc">
<img src="https://img.shields.io/badge/homebrew-mflowcode%2Fmfc%2Fmfc-brown?logo=homebrew&style=flat" />
</a>
Comment on lines +41 to +43
Copy link
Contributor

@qodo-merge-pro qodo-merge-pro bot Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Remove the trailing tab character after the closing </a> tag in the HTML for the Homebrew badge to improve code cleanliness. [general, importance: 3]

Suggested change
<a href="https://github.com/MFlowCode/homebrew-mfc">
<img src="https://img.shields.io/badge/homebrew-mflowcode%2Fmfc%2Fmfc-brown?logo=homebrew&style=flat" />
</a>
<a href="https://github.com/MFlowCode/homebrew-mfc">
<img src="https://img.shields.io/badge/homebrew-mflowcode%2Fmfc%2Fmfc-brown?logo=homebrew&style=flat" />
</a>

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.

Trailing tab character detected. Please remove the tab at the end of this line to maintain consistent whitespace formatting.

Suggested change
</a>
</a>

Copilot uses AI. Check for mistakes.
</p>

<p align="center">
Expand All @@ -59,9 +62,9 @@ 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 $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
| **Local build** | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |
| **Codespaces** (fastest) 💨 | Click the "Codespaces" badge above to launch in 1 click |
| **Homebrew** (macOS) 🍺 | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
| **Local build** 💻 | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |

**Welcome!**
MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do).
Expand Down Expand Up @@ -127,6 +130,16 @@ And here is a high-amplitude acoustic wave reflecting and emerging through a cir

## Getting started

You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get you get started using MFC on your local machine, cluster, or supercomputer!
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.

Grammatical error: "to get you get started" should be "to get you started" (remove the duplicate "get").

Suggested change
You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get you get started using MFC on your local machine, cluster, or supercomputer!
You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get you started using MFC on your local machine, cluster, or supercomputer!

Copilot uses AI. Check for mistakes.
It's rather straightforward.
Some examples are below.

### Codespaces and Containers

<a href="https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=MFlowCode%2FMFC">
<img src="https://img.shields.io/badge/Codespaces-Open%20in%201%20click-2ea44f?logo=github" />
</a>

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.

Trailing whitespace detected at the end of this line. Please remove it to maintain clean formatting.

Suggested change

Copilot uses AI. Check for mistakes.
For a _very_ quick start, open a GitHub Codespace to load a pre-configured Docker container and familiarize yourself with MFC commands.
Click <kbd> <> Code</kbd> (green button at top right) → <kbd>Codespaces</kbd> (right tab) → <kbd>+</kbd> (create a codespace).

Expand All @@ -135,11 +148,12 @@ Click <kbd> <> Code</kbd> (green button at top right) → <kbd>Codespaces</kbd>
> Don't conduct any critical work here!
> To learn more, please see [how Docker & Containers work](https://mflowcode.github.io/documentation/md_docker.html).

You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get you get started using MFC on your local machine, cluster, or supercomputer!
It's rather straightforward.

### macOS quick start (Homebrew)

<a href="https://github.com/MFlowCode/homebrew-mfc">
<img src="https://img.shields.io/badge/homebrew-mflowcode%2Fmfc%2Fmfc-brown?logo=homebrew&style=flat" />
</a>

Install the prebuilt package and run an example:

```bash
Expand Down