diff --git a/README.md b/README.md index c84ea95..a88b883 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,19 @@ width="256" />

lizardbyte-common

-

Common helper scripts and repository tooling for LizardByte projects

+

Common library and helpers for LizardByte projects.

+ GitHub stars CI - Codecov - SonarCloud + Codecov + SonarCloud
-## Overview +# Overview + +## ℹ️ About This repository contains shared helper scripts, repository-level tooling, and C++ helpers used across LizardByte projects. @@ -27,7 +30,7 @@ The current tooling includes Python-managed helpers, reusable GitHub workflows, - `lizardbyte::common` provides shared C++ helpers, starting with environment variable manipulation. - `lizardbyte::test_support` provides shared GoogleTest fixtures and test macros for LizardByte C++ projects. -## Python Tooling +## ⚙️ Python Tooling Install [uv](https://docs.astral.sh/uv/) and sync the locked tool environment: @@ -91,7 +94,7 @@ cmake -DBUILD_DOCS=ON -DBUILD_TESTS=OFF -B build/docs -S . cmake --build build/docs --target docs ``` -## Consuming Projects +## 📐 Consuming Projects Projects with a `pyproject.toml` can use this repository as a local path dependency. For a submodule at `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) target_link_libraries(my_test_binary PRIVATE lizardbyte::test_support) ``` -## Workflows +## ♾️ Workflows Reusable GitHub workflows live under `.github/workflows/`. @@ -175,7 +178,7 @@ jobs: GH_TOKEN: ${{ secrets.GH_BOT_TOKEN }} ``` -## Tests +## 🧪 Tests Run the pytest suite: