TsukiNi22/ai-utils / skills/docs/readme-style
readme-style
FlaggedTsukini's style for README.md and Markdown documentation (from libutils, context-forge, c2dmp-hsm, s.o.s) - title + tagline, Table of Contents, Dependencies/Packages/Quick Setup/Usage/Workflows sections, GitHub callouts, tables, bash blocks. Use whenever writing, rewriting or reviewing a README or any Markdown doc for one of the user's projects. For a GitHub wiki use wiki-style; for CHANGELOG/release notes use git-conventions; for HTML docs use html-doc.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 4.8 KB |
| templates/README-lib.md | markdown | 736 B |
| templates/README.md | markdown | 3.4 KB |
templates/README.md
View on GitHub# <project-name>
> [!TIP]
> Documentation [<owner>/<repo>](https://<owner>.github.io/<repo>) (v1.0.0).
<What the project is in one sentence: `<project> <mode>` does X, using Y.>
<What happens when something is missing (fallback / limits).>
### Table of Contents
- [Dependencies](#dependencies)
- [Packages](#packages)
- [Quick Setup 1 (All)](#quick-setup---1-all)
- [Quick Setup 2 (Limited)](#quick-setup---2-limited)
- [Usage](#usage)
- [Unit tests](#unit-tests)
- [Workflows/Release](#workflowsrelease)
## Dependencies
> [!CAUTION]
> This project's license does not apply to the content of the dependencies used by `<project>`.
| Name + Link | Status | Last Update |
| ----------- | ------ | ----------- |
| [libutils](https://github.com/TsukiNi22/libutils) |  |  |
Build requirements (only needed for the [Quick Setup 1](#quick-setup---1-all)):
| Name | Version | Fedora (`dnf`) | Debian/Ubuntu (`apt`) |
| ---- | ------- | -------------- | --------------------- |
| `clang++` / `cmake` | C++20 / `>= 3.20` | `clang cmake` | `clang cmake` |
## Packages
> [!NOTE]
> The package have a pre-release/unstable version named `<project>-pre`.
> The `-pre` package is marked as obsolete by any release/stable package (without `-pre`) of the same version or higher.
| File Name | Content |
| --------- | ------- |
| `<project>` | Stable binary |
| `<project>-pre` | Pre-release/unstable binary |
## Quick Setup - 1 (all)
> Setup into `/usr/local`
### Clone the repository
```bash
git clone https://github.com/<owner>/<repo>.git
cd <repo>
```
### Build & install
```bash
export BUILD_DIR=build
cmake -S . -B $BUILD_DIR
cmake --build $BUILD_DIR --parallel $(nproc) # build the binary
sudo cmake --install $BUILD_DIR # install the binary
```
## Quick Setup - 2 (Limited)
> Setup into `/usr`
> [!WARNING]
> Restriction: `fedora-based (rpm)`, `debian-based (deb)`
> [!NOTE]
> The usage of `sudo` in the script can be remove using `--no-sudo` argument
Run the setup script directly, without cloning the repository manually. It:
1. Setup the mirror
2. Import the GPG key used to sign the packages/metadata
3. Install the package
```bash
wget -qO- https://raw.githubusercontent.com/<owner>/<repo>/main/setup.sh | bash -s
```
or with `curl`:
```bash
curl -fsSL https://raw.githubusercontent.com/<owner>/<repo>/main/setup.sh | bash -s
```
| Argument | Effect |
| -------- | ------ |
| `--no-sudo` | Run without sudo (requires the script to be run as root already) |
## Usage
```bash
<project> -h # help
<project> <mode> <args> # what it does
```
| Mode | Flags |
| ---- | ----- |
| `<mode>` | `-x\|--example <value>` |
## Unit tests
```bash
cmake -S . -B $BUILD_DIR -DBUILD_TESTS=ON
cmake --build $BUILD_DIR --parallel $(nproc)
ctest --test-dir $BUILD_DIR --output-on-failure
```
## Workflows/Release
### Workflows
- The workflow `Dispatch (CI/CD)` runs on every push (branch `main` or tag `v*`) and decides what to trigger based on the ref/commit message
### Pre-Release (unstable)
- Pushing a tag that matches the regex `vx.x.x-pre` (`x` stands for the version number: `major`, `minor`, `fix`)
- Or pushing a commit containing the string `[build]`, preferably in the description
### Release (stable)
The release (channel `stable`) can only be triggered by pushing a tag that matches the regex `vx.x.x`
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 198k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |