Readme generator
Skill claudifytech/claude-code-skills-starter/skills/readme-generator
Free starter skills for Claude Code: conventional commits, code review, test writing, and README generation, plus a starter CLAUDE.md. From the makers of Claudify.
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.
What its author says it does
Copied from the file, not written here
Draft or refresh a project README from the codebase, not from guesswork
SKILL.md
1.4 KB, 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.
Gives 0 of the 12 instructions most readme changelog skills give
Counted across 471 of the 478 authors here whose files we hold, read 2026-08-06
- follow the Keep a Changelog formatin 31 of 471, across 26 files
- omit empty sectionsin 21 of 471
- Run from the git repository rootin 20 of 471, across 7 files
- save output directly to CHANGELOG.mdin 20 of 471, across 7 files
- Group commits into logical categoriesin 19 of 471, across 6 files
- Review the generated changelog before publishingin 19 of 471, across 6 files
- Apply changelog guidelines and brand voicein 18 of 471, across 5 files
- Exclude internal commits like refactoring and testsin 18 of 471, across 5 files
- Specify date ranges for focused changelogsin 17 of 471, across 4 files
- Convert technical commits into customer languagein 17 of 471, across 4 files
- group commits by conventional commit typein 14 of 471
- insert new entry below unreleased sectionin 14 of 471
Said here and by no other author read
- Gather facts from the repository first
- Describe what it does in two or three sentences
- Extract install and run commands from real scripts
- Document project structure if layout is non-obvious
- Document license if a license file exists
- Leave clearly marked placeholders for unconfirmed steps
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once.