Skip to content

Commit 036159c

Browse files
committed
docs: update readme
1 parent 28994b0 commit 036159c

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
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+
Install clang-format, clang-tidy, clang-query, and clang-apply-replacements binaries and Python wheels with ``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/
@@ -75,13 +75,13 @@ Install clang-tools CLI
7575
2. the installed path (for MacOS and Windows) is within the environment's
7676
variable ``PATH``.
7777

78-
Install `clang-tools` command with pip
78+
Install ``clang-tools`` command with pip
7979

8080
.. code-block:: shell
8181
8282
pip install clang-tools
8383
84-
Install `clang-tools` from git repo
84+
Install ``clang-tools`` from git repo
8585

8686
.. code-block:: shell
8787
@@ -135,10 +135,12 @@ If the installed directory is in your path, you can run the installed tools.
135135
Install wheels examples
136136
~~~~~~~~~~~~~~~~~~~~~~~~~
137137

138-
After installing the ``clang-tools`` CLI, you can install the Python wheels by running: ``clang-tools-wheel`` command.
138+
After installing the ``clang-tools`` CLI, you can install the Python wheels using the ``clang-tools-wheel`` command.
139139

140140
.. important::
141-
It is just used for cpp-linter projects to install clang tools Python wheels. For other use cases, please install the wheels with ``pip``, ``pipx``, ``uv``, or other tools.
141+
142+
The ``clang-tools-wheel`` command is primarily intended for cpp-linter projects to simplify installing clang tools Python wheels.
143+
For general use, it is recommended to install the wheels directly using ``pip``, ``pipx``, ``uv``, or similar tools.
142144

143145

144146
.. code-block:: shell

0 commit comments

Comments
 (0)