← ClaudeAtlas

project-readmelisted

Create, rewrite, update, or validate truthful README.md files for any project archetype. Use for libraries, SDKs, CLIs, web apps, API services, MCP servers, agent skills, monorepos, docs sites, GitHub Actions, extensions, container images, Terraform modules, Helm charts, model cards, dataset cards, research code, templates, demos, specs, desktop/mobile apps, badges, quick starts, setup docs, API or command references, README validation, and README quality checks.
antonio-orionus/skills · ★ 0 · Data & Documents · score 72
Install: claude install-skill antonio-orionus/skills
# Project README Use this skill to build README files from repository facts. README structure is selected by the primary reader and their first successful action, not by language ecosystem alone. ## Workflow 1. Inspect the repository before writing: ```bash SCRIPT=$(find ~ -maxdepth 8 -name "inspect.py" -path "*/project-readme/scripts/*" 2>/dev/null | head -1) [ -n "$SCRIPT" ] && python3 "$SCRIPT" . || echo "Script not found; inspect manifests and repo facts manually." ``` 2. Use the inspector output: - `ecosystem` controls install commands, package metadata, badges, dev commands, and language-specific examples. - `readme_type` controls structure, first screen, section order, and reader journey. - `readme_type_candidates` is the ambiguity set. If `readme_type` is `unknown` and candidates exist, ask one clarifying question based on the candidate first actions. If work must proceed without an answer, choose the type whose first successful action is best supported by repo facts. - `agent_skills` lists detected skill files and plugin manifests when `readme_type` is `agent-skill`; use it to build collection indexes and validation sections. 3. Load only the needed modules: - Ecosystem: `ecosystems/<ecosystem>.md`, or each ecosystem when `ecosystem` is `mixed`. - Type: `project-types/<readme_type>.md`. - Shared ordering: `references/section-order.md`. - Badges: `references/badge-patterns.md`. - Validation rules: `references/validation.md`