make-readme
CommunityGenerate project READMEs instantly.
Authorgupsammy
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the creation of professional README.md files, saving developers significant time and ensuring consistent project documentation.
Core Features & Use Cases
- Automated README Generation: Creates READMEs from minimal to comprehensive, including badges, tables of contents, and structured sections.
- Contextual Awareness: Scans the project for manifest files (
package.json,pyproject.toml, etc.) to pre-fill project details. - Interactive Interview: Gathers user preferences on project type, depth, sections, badges, and style through guided questions.
- Use Case: A developer finishes a new Python library and needs a README. They run the
make-readmeskill, answer a few questions about the project's features and desired sections, and receive a complete, well-formatted README file.
Quick Start
Use the make-readme skill to generate a README for the current project.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: make-readme Download link: https://github.com/gupsammy/Claudest/archive/main.zip#make-readme Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.