Skip to content

Commit 87b0484

Browse files
committed
Added information on clang-format-wheel
https://github.com/ssciwr/clang-format-wheel fixes #40
1 parent 175887d commit 87b0484

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -261,13 +261,21 @@ As this is also the minimum version of pre-commit, this should not be an issue.
261261

262262
Use these commands to install some or all of the linters used in this project:
263263

264-
* Linux/Macos
265-
* `brew install llvm uncrustify cppcheck include-what-you-use`
266-
* `pip install cpplint`
267-
* `brew install oclint` (macos), see note below for oclint on Linux
264+
* Linux
265+
* `brew install llvm uncrustify cppcheck include-what-you-use` [1]
266+
* See note below for oclint on Linux
267+
* MacOS
268+
* `brew install llvm uncrustify cppcheck include-what-you-use oclint`
268269
* Windows
269-
* `choco install llvm uncrustify cppcheck inlcude-what-you-use` [4]
270+
* `choco install llvm uncrustify cppcheck inlcude-what-you-use`
271+
* Cross-platform
270272
* `pip install cpplint`
273+
* `pipx install clang-format==<version>` [2]
274+
275+
[1]: llvm includes tools like `clang-format` and `clang-tidy`.
276+
[2]: This will download a specific `<version>` of a clang-format binary, from `10.0.1` and up.
277+
Check out the [clang-format-wheel repository](https://github.com/ssciwr/clang-format-wheel) for information on
278+
how to download the clang-format binary as part of a CI pre-commit build.
271279

272280
While it's possible to use other package managers to install these utilities on Linux, I recommend
273281
using brew to avoid dependency issues between llvm and linters that use it.

0 commit comments

Comments
 (0)