Write a README from code and command help in Claude Code

Use source code, command help, and configuration to write project instructions within the user's requested scope.

Install in Claude Code

A Claude Code project with readable code and actual command help. This exercise changes only Quick Start.

Review `.claude/skills/readme/SKILL.md` and its requirements at the pinned GitHub commit.
Create `.claude/skills/readme/` in your project and save the reviewed file as `.claude/skills/readme/SKILL.md`.
Start Claude Code from that project's root, then select `/readme` in the slash menu.

Example task

The fictional list-kit tool prints activity names one per line. Update only Quick Start. Its help shows `list-kit show --format text`. The sample input contains Leaf Exhibition and Map Class.

What to check

Quick Start shows `list-kit show --format text` and explains that the sample prints two activity names on separate lines. Ask the maintainer to confirm any install instruction missing from the provided help.

Original SKILL.md on GitHub · Updated 2026-11-14

Frequently asked question

Where should a Quick Start flag be verified?

Check source code against actual command help. Use the verified options in a short example, then check that commands, flags, and paths match the current project.