readme-skeleton

von AgentsRoomVon AgentsRoom verifiziertNoch keine InstallationNoch keine LikesAktualisiert am 7. Mai 2026Kategorie: Engineering

Was er macht

Use when adding a README to a project or sub-package. Generates the minimum useful sections without filler.

Die Installation öffnet diesen Eintrag in deiner AgentsRoom-Desktop-App. Ist die App noch nicht installiert, landest du auf der Download-Seite.

SKILL.md

---
name: readme-skeleton
description: Use when adding a README to a project or sub-package. Generates the minimum useful sections without filler.
---

# README skeleton

When asked to add or rewrite a README, produce these sections in this order:

1. **One-liner** — what does this thing do, in 12 words max.
2. **Quick start** — exact commands to clone + install + run + see it working.
3. **Configuration** — required env vars, with examples and what happens when missing.
4. **Project structure** — only if non-obvious; one paragraph max.
5. **Contributing** — branch convention, test command, PR review expectation.

Skip: marketing fluff, badges nobody clicks, screenshots that go stale, history.

Mehr zum Thema

Claude Ads: das Claude-Code-Skill, das deine Werbekonten prüft

Claude Ads ist ein Open-Source-Skill für Claude Code: über 250 Prüfungen auf Google, Meta, LinkedIn, TikTok oder Amazon Ads, ein Score von 100 und ein priorisierter Aktionsplan, in rund zehn Minuten. Installation, Befehle, Grenzen und wie du es in AgentsRoom orchestrierst.

AGENTS.md: eine Kontextdatei für jeden Coding-Agenten (Codex, Antigravity, Claude)

AGENTS.md ist die portable Anweisungsdatei, die deine KI-Coding-Agenten lesen, bevor sie deinen Code anfassen. Was reingehört, wie sie sich von CLAUDE.md unterscheidet und wie du einen einzigen Kontext über Codex, Antigravity und Claude hinweg behältst.