菜单
Creates comprehensive README files with templates for different project types. Use when creating README, project documentation, or getting started guides.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | readme-generator |
| description | Creates comprehensive README files with templates for different project types. Use when creating README, project documentation, or getting started guides. |
Generate a README based on project type:
# Detect project type
ls package.json && echo "Node.js project" || \
ls setup.py pyproject.toml && echo "Python project" || \
ls go.mod && echo "Go project"
Gather project information:
Choose template based on project type:
| Type | Template | Key Sections |
|---|---|---|
| Library | library | Installation, API, Examples |
| CLI Tool | cli | Installation, Commands, Options |
| Web App | webapp | Features, Setup, Deployment |
| API | api | Endpoints, Authentication, Examples |
Title and Description:
# Project Name
Brief one-line description of what the project does.
[](LICENSE)
[](package.json)
Installation:
## Installation
\`\`\`bash
npm install project-name
# or
pip install project-name
\`\`\`
Usage:
## Usage
\`\`\`javascript
const project = require('project-name');
// Basic example
project.doSomething();
\`\`\`
Include relevant sections:
Common badges:
For detailed information, see: