القائمة
Generates professional README.md files for projects with customizable templates
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | readme-generator |
| description | Generates professional README.md files for projects with customizable templates |
| version | 1.0.0 |
| author | cli_sync |
This skill generates comprehensive README.md files for projects. It provides customizable templates for different project types including Python, Node.js, CLI tools, and libraries. The generated READMEs follow best practices and include all essential sections.
project_name: Name of the project (required)project_type: Type of project - python, nodejs, cli, library, or generic (optional, default: "generic")description: Brief description of the project (optional)author: Author name (optional, default: "Unknown")include_screenshots: Whether to include screenshot placeholders (optional, default: true)license: License type (optional, default: "MIT")readme_generator --project_name "my_project" --project_type "python"
readme_generator --project_name "my_cli_tool" --project_type "cli" --description "A powerful CLI tool" --author "John Doe" --license "MIT"
readme_generator --project_name "my_library" --project_type "library" --include_screenshots false
Includes: Installation, Usage, Testing, Contributing sections
Includes: Installation, CLI usage, API reference, Scripts
Includes: Installation (via Homebrew/npm), Commands reference, Examples
Includes: API documentation, Examples, Type definitions
Includes: Basic sections suitable for any project type
All templates include: