diff --git a/README.md b/README.md index 5bd2e7d7e..b3ef3ae82 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,9 @@ + + +

@@ -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). @@ -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! +It's rather straightforward. +Some examples are below. + +### Codespaces and Containers + + + + + For a _very_ quick start, open a GitHub Codespace to load a pre-configured Docker container and familiarize yourself with MFC commands. Click <> Code (green button at top right) → Codespaces (right tab) → + (create a codespace). @@ -135,11 +148,12 @@ Click <> Code (green button at top right) → Codespaces > 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) + + + + Install the prebuilt package and run an example: ```bash