Skip to content

Commit 7ef7bb7

Browse files
committed
docs: update README with new logo and enhanced layout, including installation and usage badges
1 parent 70f8170 commit 7ef7bb7

3 files changed

Lines changed: 33 additions & 20 deletions

File tree

README.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
1-
# cppllvm
1+
<p align="center">
2+
<img src="assets/logo.png" width="400"/>
3+
<br>
4+
<img src='assets/logo_license.svg'>
5+
</p>
26

3-
`cppllvm` is a monorepo for Python-packaged C/C++ LLVM command-line tools.
7+
<span align="center">
48

5-
[![PyPI - ctidy](https://img.shields.io/pypi/v/ctidy?label=ctidy&logo=pypi&logoColor=white)](https://pypi.org/project/ctidy/)
6-
[![PyPI - cformat](https://img.shields.io/pypi/v/cformat?label=cformat&logo=pypi&logoColor=white)](https://pypi.org/project/cformat/)
7-
[![Checks](https://github.com/BayernMuller/cppllvm/actions/workflows/checks.yml/badge.svg)](https://github.com/BayernMuller/cppllvm/actions/workflows/checks.yml)
8-
[![Wheels ctidy](https://github.com/BayernMuller/cppllvm/actions/workflows/wheel-ctidy.yml/badge.svg)](https://github.com/BayernMuller/cppllvm/actions/workflows/wheel-ctidy.yml)
9-
[![Wheels cformat](https://github.com/BayernMuller/cppllvm/actions/workflows/wheel-cformat.yml/badge.svg)](https://github.com/BayernMuller/cppllvm/actions/workflows/wheel-cformat.yml)
10-
[![Release ctidy](https://github.com/BayernMuller/cppllvm/actions/workflows/release-ctidy.yml/badge.svg)](https://github.com/BayernMuller/cppllvm/actions/workflows/release-ctidy.yml)
11-
[![Release cformat](https://github.com/BayernMuller/cppllvm/actions/workflows/release-cformat.yml/badge.svg)](https://github.com/BayernMuller/cppllvm/actions/workflows/release-cformat.yml)
9+
# cppllvm
1210

13-
The repository currently publishes two wheel-only packages:
11+
</span>
1412

15-
- `ctidy`: bundled `clang-tidy`, `clang-apply-replacements`, LLVM resource headers, and `run-clang-tidy.py`
16-
- `cformat`: bundled `clang-format`
13+
<p align="center">
14+
<a href="https://pypi.org/project/ctidy/"><img src="https://img.shields.io/pypi/v/ctidy?label=ctidy&logo=pypi&logoColor=white" alt="ctidy"/></a>
15+
<a href="https://pypi.org/project/cformat/"><img src="https://img.shields.io/pypi/v/cformat?label=cformat&logo=pypi&logoColor=white" alt="cformat"/></a>
16+
</p>
1717

18-
Each package ships its own executable and always uses the bundled LLVM tools. There is no fallback to a system-installed `clang-tidy` or `clang-format`.
18+
<p align="center">
19+
<a href="https://github.com/BayernMuller/cppllvm/actions/workflows/checks.yml"><img src="https://github.com/BayernMuller/cppllvm/actions/workflows/checks.yml/badge.svg" alt="Checks"/></a>
20+
<a href="https://github.com/BayernMuller/cppllvm/actions/workflows/wheel-ctidy.yml"><img src="https://github.com/BayernMuller/cppllvm/actions/workflows/wheel-ctidy.yml/badge.svg" alt="Wheels ctidy"/></a>
21+
<a href="https://github.com/BayernMuller/cppllvm/actions/workflows/wheel-cformat.yml"><img src="https://github.com/BayernMuller/cppllvm/actions/workflows/wheel-cformat.yml/badge.svg" alt="Wheels cformat"/></a>
22+
<a href="https://github.com/BayernMuller/cppllvm/actions/workflows/release-ctidy.yml"><img src="https://github.com/BayernMuller/cppllvm/actions/workflows/release-ctidy.yml/badge.svg" alt="Release ctidy"/></a>
23+
<a href="https://github.com/BayernMuller/cppllvm/actions/workflows/release-cformat.yml"><img src="https://github.com/BayernMuller/cppllvm/actions/workflows/release-cformat.yml/badge.svg" alt="Release cformat"/></a>
24+
</p>
1925

20-
## Overview
26+
### Overview
2127

2228
`cppllvm` makes it easy to set up a consistent C/C++ developer environment with Python packaging.
2329

@@ -30,7 +36,7 @@ This is useful when you want:
3036
- LLVM tooling without depending on a system package manager
3137
- Python-managed C/C++ tooling that is easy to add, pin, and upgrade
3238

33-
## Releases
39+
### Releases
3440

3541

3642
| Package | PyPI project | Release trigger | Package docs |
@@ -41,7 +47,7 @@ This is useful when you want:
4147

4248
PyPI releases are wheel-only. Neither package publishes an `sdist`.
4349

44-
## Platform Availability
50+
### Platform Availability
4551

4652
Available wheels are limited to the upstream LLVM 20 prebuilt assets pinned by this repository.
4753

@@ -56,7 +62,7 @@ Available wheels are limited to the upstream LLVM 20 prebuilt assets pinned by t
5662

5763
If the upstream static build release does not publish an asset for an OS/CPU pair, this repository does not produce a wheel for that platform.
5864

59-
## Installation
65+
### Installation
6066

6167
Recommended package installation is with `uv`:
6268

@@ -74,7 +80,7 @@ uvx cformat --version
7480

7581
Package-specific usage and examples live in the package READMEs.
7682

77-
## Build And Distribution Model
83+
### Build And Distribution Model
7884

7985
This repository does not build LLVM from source. During wheel builds, each package only:
8086

@@ -83,7 +89,7 @@ This repository does not build LLVM from source. During wheel builds, each packa
8389
- for `ctidy`, downloads official LLVM release headers for `lib/clang/<major>/include`
8490
- for `ctidy`, bundles the upstream LLVM `run-clang-tidy.py`
8591

86-
## Repository Layout
92+
### Repository Layout
8793

8894
```text
8995
packages/
@@ -93,7 +99,7 @@ tests/ Repository-level tests for packaging and CLI behavior
9399
tools/ Release and maintenance helpers
94100
```
95101

96-
## Local Development
102+
### Local Development
97103

98104
Install the workspace tooling:
99105

assets/logo.png

800 KB
Loading

assets/logo_license.svg

Lines changed: 7 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)