Skip to content

Commit

Permalink
Update dependencies list on docs for building on macOS (#250)
Browse files Browse the repository at this point in the history
  • Loading branch information
madcampos authored Aug 21, 2024
1 parent 9e18047 commit 36d498b
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/src/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,17 @@ mdbook serve build/docs
> - `mdbook` can be installed with the system's package manager.
> - `mdbook serve` will by default create a local server at `http://localhost:3000`.
**Note:** If you want to build the docs on MacOS, there are two extra dependencies:
- [doxygen](https://www.doxygen.nl/)
- [graphviz](https://graphviz.org/)

Both can be installed using Homebrew by running the following commands:

```bash
brew install doxygen
brew install graphviz
```

## Dependencies

### Ubuntu Common
Expand Down Expand Up @@ -154,7 +165,7 @@ sudo apt install ninja-build

### MacOS

On MacOS we need to install the latest version of cmake and ninja which can be done using Homebrew with (Docs for installing Homebrew: https://brew.sh)
On MacOS we need to install the latest version of [cmake](https://cmake.org/), and [ninja](https://ninja-build.org/) which can be done using Homebrew with (Docs for installing Homebrew: https://brew.sh).

```bash
brew install cmake
Expand Down

0 comments on commit 36d498b

Please sign in to comment.