Goblin-mode doc-create-readme-for-gamma
{{ ƔƔƔ }} Generate a README for a specific directory
install
source · Clone the upstream repo
git clone https://github.com/JasonWarrenUK/goblin-mode
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/JasonWarrenUK/goblin-mode "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/doc-create-readme-for-gamma" ~/.claude/skills/jasonwarrenuk-goblin-mode-doc-create-readme-for-gamma && rm -rf "$T"
manifest:
skills/doc-create-readme-for-gamma/SKILL.mdsource content
Generate a README.md for the following directory:
$ARGUMENTS
Steps
- Confirm the directory exists; if not, stop and report
- Analyse the directory: purpose, contents, file structure, key modules, any existing docs
- Look at surrounding context — parent README, sibling directories, project-level docs — to understand how this directory fits into the broader codebase
- Determine appropriate README sections based on what the directory contains:
- Library/module: overview, API, usage examples, exports
- Config/infra: what it configures, how to modify, dependencies
- Commands/scripts: what each does, arguments, examples
- General: overview, structure, key files, usage notes
- Generate README content:
- Clear description of the directory's purpose
- Code blocks for any commands or usage examples
- Table of contents if more than 4 sections
- Links to related docs where relevant
- Show draft for approval before writing
Notes
- Keep it proportional to the directory's complexity — don't over-document a simple folder
- Focus on what someone new to the directory needs to know
- Include actual paths and commands, not placeholders
- Match the style of any existing project READMEs