Skip to content

Commit 98087f7

Browse files
committed
revise README about clang tools' origin
1 parent d3e381b commit 98087f7

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -185,15 +185,25 @@ apt-get install -y libc6 wget lsb-release software-properties-common gnupg
185185

186186
Otherwise, [nushell] and/or the LLVM-provided bash script will fail to run.
187187

188+
If installing clang tools fails using the `apt` package manager, then we alteratively try (in order of attempts):
189+
190+
1. PyPI Packages [clang-tidy][clang-tidy-wheel] and/or [clang-format][clang-format-wheel]
191+
2. Static binaries that we built ourselves; see [cpp-linter/clang-tools-pip] project for more detail.
192+
188193
### On macOS runners
189194

190-
The specified `version` of `clang-format` and `clang-tidy` is installed via Homebrew.
191-
Failing that, we attempt to use Python wheel that we built ourselves; see [cpp-linter/clang-tools-pip] project for more detail.
195+
The specified `version` of `clang-format` and `clang-tidy` is installed via (in order of attempts):
196+
197+
1. Homebrew
198+
2. PyPI Packages [clang-tidy][clang-tidy-wheel] and/or [clang-format][clang-format-wheel]
199+
3. Static binaries that we built ourselves; see [cpp-linter/clang-tools-pip] project for more detail.
192200

193201
### On Windows runners
194202

195-
For Windows runners, we only use clang tools Python wheels.
196-
See [cpp-linter/clang-tools-pip] project for more detail.
203+
For Windows runners, we use clang tools installed via (in order of attempts):
204+
205+
1. PyPI Packages [clang-tidy][clang-tidy-wheel] and/or [clang-format][clang-format-wheel]
206+
2. Static binaries that we built ourselves; see [cpp-linter/clang-tools-pip] project for more detail.
197207

198208
## License
199209

@@ -203,5 +213,7 @@ The scripts and documentation in this project are released under the [MIT Licens
203213
[uv]: https://docs.astral.sh/uv/
204214
[cpp-linter/clang-tools-pip]: https://github.com/cpp-linter/clang-tools-pip
205215
[gh-container-syntax]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idcontainer
216+
[clang-tidy-wheel]: https://pypi.org/project/clang-tidy
217+
[clang-format-wheel]: https://pypi.org/project/clang-format
206218

207219
<!--README-end-->

0 commit comments

Comments
 (0)