generate_readme
Create professional README.md files by analyzing project directories to generate comprehensive documentation with badges, sections, and proper formatting.
Instructions
Generate a well-formatted, visually appealing README.md file for a project. This tool analyzes the project directory and automatically creates a comprehensive README with: badges, emojis, proper sections (description, installation, usage, project structure, dependencies, etc.), code blocks, and professional formatting. The generated README is ready to use and follows best practices.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectPath | Yes | The absolute path to the project directory |
Input Schema (JSON Schema)
{
"properties": {
"projectPath": {
"description": "The absolute path to the project directory",
"type": "string"
}
},
"required": [
"projectPath"
],
"type": "object"
}