Menu
Generate project README from codebase analysis. Use when user says "write a README", "create README for this project", or initializing a new repo.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Translate Markdown files between Chinese and English. Use when user says "translate this document", "翻译这个文档", "中译英", "英译中".
Generate unit tests for selected code. Use when user says "add tests", "write unit tests", "generate test cases", or highlights code needing test coverage.
Format and optimize SQL queries. Use when user pastes SQL, says "format this SQL", "optimize this query", or "beautify SQL".
Generate release notes from git commits. Use when user says "generate release notes", "write changelog for this release", "summarize what's in vX.X".
Analyze code and suggest refactoring improvements. Use when user says "refactor this", "improve this code", "clean up", or "any suggestions for this code".
Generate pull request description from git diff. Use when user says "generate PR description", "write PR summary", or before opening a pull request.
Based on SOC occupation classification
| name | readme-gen |
| description | Generate project README from codebase analysis. Use when user says "write a README", "create README for this project", or initializing a new repo. |
Generate a comprehensive, well-structured README.md by analyzing the project codebase.
# Project Name
<p align="center">
<img src="badges" alt="badges">
</p>
Brief one-line description.
## ✨ Features
- Feature 1
- Feature 2
## 🚀 Quick Start
### Prerequisites
- Node.js >= 18
- etc.
### Installation
```bash
git clone ...
cd project
npm install
npm start
Link or brief guide.
npm test
Brief overview of project structure.
How to contribute.
MIT
## Rules
- Read actual project files, don't invent features
- Auto-detect: language, package manager, test framework, build tool
- Include real commands that work for this specific project
- If package.json has `scripts`, list the most important ones
- Keep it concise — don't write a novel