Readme generator
Skill claudifytech/claude-code-skills-starter/skills/readme-generator
Draft or refresh a project README from the codebase, not from guessworkFrom its SKILL.md
npx -y skills add claudifytech/claude-code-skills-starter --skill readme-generatorAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.4 KB, 282 tokens by cl100k_base, as published. Nobody here has run it
README Generator
Produce a clear, accurate README by reading the project, not by guessing.
When to use
When the user asks to create or update the project README.
Procedure
- Gather facts from the repo first:
package.json,pyproject.toml,go.mod, or the equivalent, for the name, description, scripts, and dependencies.- The entry point and the top-level folder structure.
- Any existing README, docs, or
.env.examplefor the real setup steps.
- Draft these sections, including only what you can verify from the repo:
- Title and one-line description.
- What it does, in two or three sentences.
- Install and run commands, taken from the real scripts, never invented.
- Configuration, if there are environment variables or config files.
- Project structure, if the layout is non-obvious.
- License, if a LICENSE file exists.
- Keep it honest. If you cannot confirm a step from the repo, leave a clearly marked placeholder rather than guessing.
- Write the result to
README.md. If one already exists, preserve any hand-written sections you cannot improve.
Notes
- Accuracy beats completeness. A short, correct README is better than a long one with wrong commands.
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.