Skip to content

Commit

Permalink
docs: update README.md and pyproject.toml (#52)
Browse files Browse the repository at this point in the history
* docs: update README.md

* chore: update pyproject.toml
  • Loading branch information
shenxianpeng authored Aug 28, 2024
1 parent d057020 commit 5c5e122
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
<!-- [![PyPI - Downloads](https://img.shields.io/pypi/dw/cpp-linter-hooks)](https://pypi.org/project/cpp-linter-hooks/) -->


`cpp-linter-hooks` integrates `clang-format` and `clang-tidy` hooks with [pre-commit](https://pre-commit.com/) to lint your C/C++ code efficiently.
cpp-linter-hooks is a [pre-commit](https://pre-commit.com/) hook that uses clang-format and clang-tidy to check your C/C++ code.

> [!NOTE]
> This hook automatically downloads a specific version of `clang-format` or `clang-tidy` [binaries](https://github.com/cpp-linter/clang-tools-static-binaries) and installs it on the system.
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"

[project]
name = "cpp_linter_hooks"
description = "Automatically check c/c++ with clang-format and clang-tidy"
description = "Automatically check c/c++ code with clang-format and clang-tidy"
readme = "README.md"
keywords = ["clang", "clang-format", "clang-tidy", "pre-commit", "pre-commit-hooks"]
license = {text = "MIT License"}
authors = [
{ name = "Peter Shen", email = "xianpeng.shen@gmail.com" },
{ name = "Xianpeng Shen", email = "xianpeng.shen@gmail.com" },
]
classifiers = [
# https://pypi.org/pypi?%3Aaction=list_classifiers
Expand Down

0 comments on commit 5c5e122

Please sign in to comment.