readme-skeleton

par AgentsRoomVérifié par AgentsRoomAucune installationAucun likeMis à jour le 7 mai 2026Catégorie : Ingénierie

Ce que ça fait

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

L'installation ouvre cette fiche dans votre application AgentsRoom. Si l'application n'est pas encore installée, vous serez redirigé vers la page de téléchargement.

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.

Pour aller plus loin

Claude Ads : le skill Claude Code qui audite tes comptes publicitaires

Claude Ads est un skill open source pour Claude Code : plus de 250 vérifications sur Google, Meta, LinkedIn, TikTok ou Amazon Ads, un score sur 100 et un plan d'action priorisé, en une dizaine de minutes. Installation, commandes, limites, et comment l'orchestrer dans AgentsRoom.

AGENTS.md : un seul fichier de contexte pour tous tes agents de code (Codex, Antigravity, Claude)

AGENTS.md, c'est le fichier d'instructions portable que tes agents de code lisent avant de toucher à ton code. Ce qu'il faut y mettre, en quoi il diffère de CLAUDE.md, et comment garder un seul contexte entre Codex, Antigravity et Claude.