Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.rst #85

Merged
merged 2 commits into from
Feb 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
clang-tools Introduction
========================
clang-tools CLI
===============

**Install clang-format, clang-tidy, clang-query, and clang-apply-replacements binaries with clang-tools CLI.**

.. image:: https://img.shields.io/pypi/v/clang-tools
:target: https://pypi.org/project/clang-tools/
Expand All @@ -20,9 +22,6 @@ clang-tools Introduction
:target: https://pypistats.org/packages/clang-tools
:alt: PyPI - Downloads


Install clang-tools binaries (clang-format, clang-tidy, clang-query and clang-apply-replacements) with pip.

.. important::
This package only manages binary executables (& corresponding symbolic links) that
are installed using this package's executable script. It does not intend to change or
Expand All @@ -47,8 +46,8 @@ Features
category.
- Customizable install path.

Install
-------
Install clang-tools CLI
-----------------------

.. tip::
It is recommended to use this package in a virtual environment.
Expand Down Expand Up @@ -82,8 +81,8 @@ Install `clang-tools` from git repo

pip install git+https://github.com/cpp-linter/clang-tools-pip.git@main

Usage
-----
CLI Usage
---------

For a list of supported Command Line Interface options, see
`the CLI documentation <https://cpp-linter.github.io/clang-tools-pip/cli_args.html>`_
Expand Down