Skip to content

Commit 5d9b364

Browse files
committed
docs: udpate README.rst
1 parent df41efc commit 5d9b364

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
clang-tools CLI
22
===============
33

4-
Install clang-format, clang-tidy, clang-query, and clang-apply-replacements binaries and Python wheels with ``clang-tools`` CLI.
4+
Easily install clang-format, clang-tidy, clang-query, and clang-apply-replacements static binaries or Python wheels using the ``clang-tools`` CLI.
55

66
.. |latest-version| image:: https://img.shields.io/pypi/v/clang-tools?color=blue
77
:target: https://pypi.org/project/clang-tools/
88
:alt: PyPI
9-
.. |python-test| image:: https://github.com/cpp-linter/clang-tools-pip/actions/workflows/python-test.yml/badge.svg
10-
:target: https://github.com/cpp-linter/clang-tools-pip/actions/workflows/python-test.yml
11-
:alt: Python test
9+
.. |test| image:: https://github.com/cpp-linter/clang-tools-pip/actions/workflows/test.yml/badge.svg
10+
:target: https://github.com/cpp-linter/clang-tools-pip/actions/workflows/test.yml
11+
:alt: test
1212
.. |codecov-badge| image:: https://codecov.io/gh/cpp-linter/clang-tools-pip/branch/main/graph/badge.svg?token=40G5ZOIRRR
1313
:target: https://codecov.io/gh/cpp-linter/clang-tools-pip
1414
:alt: codecov
@@ -22,7 +22,7 @@ Install clang-format, clang-tidy, clang-query, and clang-apply-replacements bina
2222
:target: https://pypistats.org/packages/clang-tools
2323
:alt: PyPI - Downloads
2424

25-
|latest-version| |python-test| |codecov-badge| |sonar-badge| |platform-badge| |pypi-badge|
25+
|latest-version| |test| |codecov-badge| |sonar-badge| |platform-badge| |pypi-badge|
2626

2727
.. important::
2828
This package only manages binary executables (& corresponding symbolic links) that
@@ -146,7 +146,12 @@ After installing the ``clang-tools`` CLI, you can install the Python wheels usin
146146
.. code-block:: shell
147147
148148
# Install latest clang-format wheel
149+
clang-tools-wheel --tool clang-format
150+
# Install specific version clang-format wheel
149151
clang-tools-wheel --tool clang-format --version 21
152+
153+
# Install latest clang-tidy wheel
154+
clang-tools-wheel --tool clang-tidy
150155
# Install latest clang-tidy wheel
151156
clang-tools-wheel --tool clang-tidy --version 21
152157

0 commit comments

Comments
 (0)