File tree Expand file tree Collapse file tree 1 file changed +13
-5
lines changed Expand file tree Collapse file tree 1 file changed +13
-5
lines changed Original file line number Diff line number Diff line change @@ -261,13 +261,21 @@ As this is also the minimum version of pre-commit, this should not be an issue.
261261
262262Use 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
272280While it's possible to use other package managers to install these utilities on Linux, I recommend
273281using brew to avoid dependency issues between llvm and linters that use it.
You can’t perform that action at this time.
0 commit comments