← ClaudeAtlas

readme-stylelisted

Tsukini'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.
TsukiNi22/ai-utils · ★ 1 · Data & Documents · score 74
Install: claude install-skill TsukiNi22/ai-utils
# Tsukini README / Markdown doc style English (unless the user asks for another language), direct, technical, no emoji, no marketing. **Location**: `README.md` at the root of the repository (`git rev-parse --show-toplevel`), or in the current folder outside a repository; never in `docs/` unless the user asks for it. Templates: `templates/README.md` (application or full library) and `templates/README-lib.md` (small header-only/algorithm library). CHANGELOG and release descriptions: the `git-conventions` skill. HTML documentation: the `html-doc` skill. ## Structure (full project: libutils, context-forge) ```markdown # <project-name> > [!TIP] > Documentation [<owner>/<repo>](<doc url>) (vX.Y.Z). <- only if an HTML/wiki doc exists <1-3 lines: what it is, how it works, the 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 ## Packages ## Quick Setup - 1 (all) ## Quick Setup - 2 (Limited) ## Usage ## Unit tests ## Workflows/Release ``` - `# title` = repository name as is (`context-forge`, `c2dmp-hsm`, or the display name `Utils`, `S.O.S`). - Small library (c2dmp-hsm, s.o.s): `# name`, then the acronym tagline in a quote with the bold letters (`> **S**teganography **O**ptimized and **S**ecurized`), then `## Installat