readme-skeleton

autor: AgentsRoomZweryfikowane przez AgentsRoomBrak instalacjiBrak polubieńZaktualizowano 7 maja 2026Kategoria: Inżynieria

Co robi

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

Instalacja otwiera tę pozycję w Twojej aplikacji AgentsRoom na komputerze. Jeśli aplikacji jeszcze nie ma, trafisz na stronę pobierania.

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.

Tagi

docs

Warto przeczytać

Claude Ads: skill Claude Code, który audytuje konta reklamowe

Claude Ads to open source'owy skill dla Claude Code: ponad 250 sprawdzeń na Google, Meta, LinkedIn, TikTok czy Amazon Ads, wynik na 100 i priorytetowy plan działania, w kilkanaście minut. Instalacja, komendy, ograniczenia i jak go orkiestrować w AgentsRoom.

AGENTS.md: jeden plik kontekstu dla każdego agenta kodującego (Codex, Antigravity, Claude)

AGENTS.md to przenośny plik z instrukcjami, który twoje agenty kodujące czytają, zanim dotkną kodu. Co w nim umieścić, czym różni się od CLAUDE.md i jak utrzymać jeden kontekst dla Codex, Antigravity i Claude.