Skip to content

Enhance README.md: Add project description and website links #16

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.

Sign up for GitHub

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

Merged
shenxianpeng merged 2 commits into from
Apr 20, 2026
+20 −0
Merged

Enhance README.md: Add project description and website links #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1327b58
Enhance README.md: Add project description and website links
shenxianpeng Apr 20, 2026
5b8e8a1
Fix badge styling in README.md for website link
shenxianpeng Apr 20, 2026
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,21 @@
# cpp-linter.github.io

[![Website](https://img.shields.io/static/v1?logo=googlechrome&logoColor=white&label=Website&message=cpp-linter.github.io&color=yellow)](https://cpp-linter.github.io/)
[![GitHub Org](https://img.shields.io/badge/github-cpp--linter-181717?logo=github)](https://github.com/cpp-linter)
[![License](https://img.shields.io/github/license/cpp-linter/cpp-linter.github.io)](LICENSE)
[![MkDocs](https://img.shields.io/badge/docs-MkDocs%20Material-526CFE?logo=materialformkdocs&logoColor=white)](https://cpp-linter.github.io/)

Documentation website for the `cpp-linter` project and organization.

This repository hosts the public site at <https://cpp-linter.github.io/>, including the homepage, getting started guides, and community links for the C/C++ linting ecosystem around `cpp-linter`.

## Website

- Main site: <https://cpp-linter.github.io/>
- GitHub organization: <https://github.com/cpp-linter>

## What You'll Find

- Project overview and landing page content
- Getting started documentation
- Discussion and community entry points