55 width="256"
66 />
77 <h1 align =" center " >lizardbyte-common</h1 >
8- <h4 align =" center " >Common helper scripts and repository tooling for LizardByte projects</h4 >
8+ <h4 align =" center " >Common library and helpers for LizardByte projects. </h4 >
99</div >
1010
1111<div align =" center " >
12+ <a href =" https://github.com/LizardByte/lizardbyte-common " ><img src =" https://img.shields.io/github/stars/lizardbyte/lizardbyte-common.svg?logo=github&style=for-the-badge " alt =" GitHub stars " ></a >
1213 <a href =" https://github.com/LizardByte/lizardbyte-common/actions/workflows/ci.yml?query=branch%3Amaster " ><img src =" https://img.shields.io/github/actions/workflow/status/lizardbyte/lizardbyte-common/ci.yml.svg?branch=master&label=CI&logo=github&style=for-the-badge " alt =" CI " ></a >
13- <a href =" https://codecov.io/gh/LizardByte/lizardbyte-common " ><img src =" https://img.shields.io/endpoint?url=https%3A%2F%2Fapp.lizardbyte.dev%2Fdashboard%2Fshields%2Fcodecov%2Flizardbyte-common.json&style=for-the-badge&logo=codecov " alt =" Codecov " ></a >
14- <a href =" https://sonarcloud.io/project/overview?id=LizardByte_lizardbyte-common " ><img src =" https://img.shields.io/sonar/quality_gate/LizardByte_lizardbyte-common?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarcloud " alt =" SonarCloud " ></a >
14+ <a href =" https://codecov.io/gh/LizardByte/lizardbyte-common " ><img src =" https://img.shields.io/endpoint.svg ?url=https%3A%2F%2Fapp.lizardbyte.dev%2Fdashboard%2Fshields%2Fcodecov%2Flizardbyte-common.json&style=for-the-badge&logo=codecov " alt =" Codecov " ></a >
15+ <a href =" https://sonarcloud.io/project/overview?id=LizardByte_lizardbyte-common " ><img src =" https://img.shields.io/sonar/quality_gate/LizardByte_lizardbyte-common.svg ?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarcloud " alt =" SonarCloud " ></a >
1516</div >
1617
17- ## Overview
18+ # Overview
19+
20+ ## ℹ️ About
1821
1922This repository contains shared helper scripts, repository-level tooling, and C++ helpers used across LizardByte
2023projects.
@@ -27,7 +30,7 @@ The current tooling includes Python-managed helpers, reusable GitHub workflows,
2730- ` lizardbyte::common ` provides shared C++ helpers, starting with environment variable manipulation.
2831- ` lizardbyte::test_support ` provides shared GoogleTest fixtures and test macros for LizardByte C++ projects.
2932
30- ## Python Tooling
33+ ## ⚙️ Python Tooling
3134
3235Install [ uv] ( https://docs.astral.sh/uv/ ) and sync the locked tool environment:
3336
@@ -91,7 +94,7 @@ cmake -DBUILD_DOCS=ON -DBUILD_TESTS=OFF -B build/docs -S .
9194cmake --build build/docs --target docs
9295```
9396
94- ## Consuming Projects
97+ ## 📐 Consuming Projects
9598
9699Projects with a ` pyproject.toml ` can use this repository as a local path dependency. For a submodule at
97100` third-party/lizardbyte-common ` , add the dependency and source to the consuming project's ` pyproject.toml ` :
@@ -145,7 +148,7 @@ add_subdirectory(third-party/lizardbyte-common)
145148target_link_libraries(my_test_binary PRIVATE lizardbyte::test_support)
146149```
147150
148- ## Workflows
151+ ## ♾️ Workflows
149152
150153Reusable GitHub workflows live under ` .github/workflows/ ` .
151154
@@ -175,7 +178,7 @@ jobs:
175178 GH_TOKEN : ${{ secrets.GH_BOT_TOKEN }}
176179` ` `
177180
178- ## Tests
181+ ## 🧪 Tests
179182
180183Run the pytest suite:
181184
0 commit comments