From 66eea943b75e0a73dad77dc0246ed9d9e299da3c Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Thu, 1 Oct 2026 11:15:33 +0300 Subject: [PATCH] docs: say what the repository holds in the README The README was two lines ("Org Metadata"). Name the repository, list what it holds, and add the link line the other cpp-linter READMEs use. Add two sections for what other repositories depend on: the reusable workflows, which reach every caller on its next run, and the brand assets with the command that regenerates the profile banners. --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 265641b..93a9def 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ -# Org Metadata +# .github -Global configurations and assets for the cpp-linter organization on GitHub. +Organization-wide files for [cpp-linter](https://github.com/cpp-linter): the +[profile README](https://github.com/cpp-linter/.github/blob/main/profile/README.md), the default +contributing guide, code of conduct, security policy, support page, issue and pull request templates, +reusable workflows and the brand assets. + +[Website](https://cpp-linter.github.io/) · +[Get started](https://cpp-linter.github.io/getting-started/) · +[Discussions](https://github.com/orgs/cpp-linter/discussions) + +## Reusable workflows + +The other cpp-linter repositories call the workflows in +[`.github/workflows/`](https://github.com/cpp-linter/.github/tree/main/.github/workflows) with +`uses: cpp-linter/.github/.github/workflows/.yml@main`, so a change to one of them reaches +every repository that calls it on its next run. `main.yml` only runs this repository's own checks. + +## Brand assets + +[`branding/`](https://github.com/cpp-linter/.github/tree/main/branding) holds the logos, the social +preview images and the profile banner generator; its +[README](https://github.com/cpp-linter/.github/blob/main/branding/README.md) lists them. The profile +banners in `assets/` come from `uv run branding/profile-banner/generate.py`. + +## License + +[MIT](https://github.com/cpp-linter/.github/blob/main/LICENSE)