Skip to content

Commit

Permalink
Update getting-started.md (#378)
Browse files Browse the repository at this point in the history
  • Loading branch information
sbryngelson authored Mar 22, 2024
1 parent bebf7bf commit 36d989f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,26 @@ Another example is the high-Mach flow over an airfoil, shown below.

You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get started using MFC!
It's rather straightforward.

We'll give a brief intro. here for MacOS.
Using [brew](https://brew.sh), install MFC's modest set of dependencies:
```console
brew install wget make python make cmake coreutils gcc mpich
brew install wget python cmake gcc@13 mpich
```
You're now ready to build and test MFC!
Clone it to a convenient directory via
Put it to a convenient directory via
```console
git clone https://github.com/mflowcode/MFC.git
cd MFC
```
then build and test!
and make sure MFC knows what compilers to use by putting the following in your `~/.profile`
```console
export CC=gcc-13
export CXX=g++-13
export FC=gfortran-13
```
and source that file, build, and test!
```console
source ~/.profile
./mfc.sh build -j 8
./mfc.sh test -j 8
```
Expand Down
5 changes: 3 additions & 2 deletions docs/documentation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ sudo apt update
sudo apt upgrade
sudo apt install tar wget make cmake gcc g++ \
python3 python3-dev \
"openmpi-*" libopenmpi-dev
"openmpi-*" libopenmpi-dev \
python3-venv
```

- **Via [Pacman](https://wiki.archlinux.org/title/pacman):**
Expand Down Expand Up @@ -120,7 +121,7 @@ export FC=gfortran-$MFC_GCC_VER
**Close the open editor and terminal window**. Open a **new terminal** window before executing the commands below.

```console
brew install wget make python make cmake coreutils gcc@$MFC_GCC_VER mpich
brew install wget python cmake gcc@$MFC_GCC_VER mpich
```

They will download the dependencies MFC requires to build itself.
Expand Down

0 comments on commit 36d989f

Please sign in to comment.