Skip to content

Commit 9f40b5e

Browse files
authored
Improve README formatting and add emojis (#1041)
1 parent 9027349 commit 9f40b5e

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@
3838
<a href="https://github.com/MFlowCode/MFC/releases">
3939
<img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release" />
4040
</a>
41+
<a href="https://github.com/MFlowCode/homebrew-mfc">
42+
<img src="https://img.shields.io/badge/homebrew-mflowcode%2Fmfc%2Fmfc-brown?logo=homebrew&style=flat" />
43+
</a>
4144
</p>
4245

4346
<p align="center">
@@ -59,9 +62,9 @@ MFC runs at exascale on the world's fastest supercomputers:
5962

6063
| Path | Command |
6164
| --- | --- |
62-
| **Codespaces** (fastest) | Click the "Codespaces" badge above to launch in 1 click |
63-
| **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
64-
| **Local build** | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |
65+
| **Codespaces** (fastest) 💨 | Click the "Codespaces" badge above to launch in 1 click |
66+
| **Homebrew** (macOS) 🍺 | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
67+
| **Local build** 💻 | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |
6568

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

128131
## Getting started
129132

133+
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!
134+
It's rather straightforward.
135+
Some examples are below.
136+
137+
### Codespaces and Containers
138+
139+
<a href="https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=MFlowCode%2FMFC">
140+
<img src="https://img.shields.io/badge/Codespaces-Open%20in%201%20click-2ea44f?logo=github" />
141+
</a>
142+
130143
For a _very_ quick start, open a GitHub Codespace to load a pre-configured Docker container and familiarize yourself with MFC commands.
131144
Click <kbd> <> Code</kbd> (green button at top right) → <kbd>Codespaces</kbd> (right tab) → <kbd>+</kbd> (create a codespace).
132145

@@ -135,11 +148,12 @@ Click <kbd> <> Code</kbd> (green button at top right) → <kbd>Codespaces</kbd>
135148
> Don't conduct any critical work here!
136149
> To learn more, please see [how Docker & Containers work](https://mflowcode.github.io/documentation/md_docker.html).
137150
138-
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!
139-
It's rather straightforward.
140-
141151
### macOS quick start (Homebrew)
142152

153+
<a href="https://github.com/MFlowCode/homebrew-mfc">
154+
<img src="https://img.shields.io/badge/homebrew-mflowcode%2Fmfc%2Fmfc-brown?logo=homebrew&style=flat" />
155+
</a>
156+
143157
Install the prebuilt package and run an example:
144158

145159
```bash

0 commit comments

Comments
 (0)