Skip to content

Commit

Permalink
remove old clang-format installation instructions from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
graebm committed Jun 13, 2024
1 parent 28b614c commit d5c0ebc
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions guides/dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,11 @@ the code is formatted correctly.
`autopep8` is used for python code. You installed this earlier via `requirements-dev.txt`.
For C code `clang-format` is used (specifically version 9).
To install this on Mac using homebrew, run:
For C code `clang-format` is used. You need to install an exact version (see `CLANG_FORMAT_VERSION=...` line at the top of [format-check.py](../../format-check.py)) via [pipx](https://github.com/pypa/pipx). Doing this on MacOS looks like:
```sh
(.venv) $ brew install llvm@9
(.venv) $ brew install pipx
(.venv) $ pipx ensurepath
(.venv) $ pipx install clang-format==<CLANG_FORMAT_VERSION from format-check.py>
```
Use helper scripts to automatically format your code (or configure your IDE to do it):
Expand Down

0 comments on commit d5c0ebc

Please sign in to comment.