Claude Code create-readme from project configuration
Review a project’s layout and verified entry point, then write a concise README and setup directions in GitHub Flavored Markdown.
中文Install in Claude Code
Open the project in Claude Code with its build configuration, entry point, and any existing project assets available for inspection.
- Review `.claude/skills/create-readme/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.claude/skills/create-readme/` in your project and save the reviewed file as `.claude/skills/create-readme/SKILL.md`.
- Start Claude Code from that project's root, then select `/create-readme` in the slash menu.
Example task
In meter-05, the project file is MeterSample.csproj. The development notes give “dotnet run --project MeterSample.csproj”. The repository has separate LICENSE and CHANGELOG.md files.What to check
The README explains the purpose and preserves “dotnet run --project MeterSample.csproj” in the startup steps. License and change history stay in their dedicated files.
Original SKILL.md on GitHub · Updated
Frequently asked question
How do I keep commands accurate in the README?
Check the directories, project name, and entry point against the real project configuration before adding the command to the startup instructions.