Skip to content

Commit 336fdd7

Browse files
committed
Installation notes reformatting
1 parent 87b0484 commit 336fdd7

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

+12-14
Original file line numberDiff line numberDiff line change
@@ -262,31 +262,29 @@ As this is also the minimum version of pre-commit, this should not be an issue.
262262
Use these commands to install some or all of the linters used in this project:
263263

264264
* Linux
265-
* `brew install llvm uncrustify cppcheck include-what-you-use` [1]
266-
* See note below for oclint on Linux
265+
* `brew install llvm uncrustify cppcheck include-what-you-use` [1] [2]
266+
* `oclint`: See note below for installation [3]
267267
* MacOS
268268
* `brew install llvm uncrustify cppcheck include-what-you-use oclint`
269269
* Windows
270270
* `choco install llvm uncrustify cppcheck inlcude-what-you-use`
271271
* Cross-platform
272272
* `pip install cpplint`
273-
* `pipx install clang-format==<version>` [2]
273+
* `pipx install clang-format` [4]
274274

275275
[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.
279276

280-
While it's possible to use other package managers to install these utilities on Linux, I recommend
281-
using brew to avoid dependency issues between llvm and linters that use it.
277+
[2]: While it's possible to use other package managers to install these utilities on Linux, I recommend
278+
using brew to avoid dependency issues between llvm and linters that use it, such as include-what-you-use.
282279

283-
#### Installing oclint
280+
[3]: You can install on MacOS with `brew install oclint`. Oclint's github page also provides compiled
281+
binary packages (and zip of source code to compile) for Macos/Linux:
282+
[releases](https://github.com/oclint/oclint/releases). oclint is not available on windows.
284283

285-
You can install on MacOS with `brew install oclint`.
286-
287-
Oclint's github page also provides compiled binary packages (and zip of source code to compile) for Macos/Linux: [releases](https://github.com/oclint/oclint/releases).
288-
289-
oclint is not available on windows.
284+
[4]: This will download the latest version. Versions from `10.0.1` and up are supported.
285+
To pin to a specific version like `13.0.0`, use `pipx install clang-format==13.0.0`.
286+
Check out the [clang-format-wheel repository](https://github.com/ssciwr/clang-format-wheel) for information on
287+
how to download the clang-format binary as part of a CI pre-commit build.
290288

291289
### Hook Info
292290

0 commit comments

Comments
 (0)