skills.rest
pardnchiu
pardnchiuCOMMUNITY
Explore all skills by this author →
Website𝕏@pardnioGitHub

readme-generate

Analyze source code to generate bilingual READMEs and documentation sets.

4|Updated Jan 21, 2026
Search Tags:#automation#documentation#cli#readme#code-analysis#bilingual
One-click install
npx skills add https://github.com/pardnchiu/skill-readme-generate --skill readme-generate-pardnchiu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-generate
Source: https://github.com/pardnchiu/skill-readme-generate/tree/main
Command: npx skills add https://github.com/pardnchiu/skill-readme-generate --skill readme-generate-pardnchiu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Manages end-to-end documentation generation by analyzing source code to create bilingual READMEs (README.md and README.zh.md) and a comprehensive doc structure, reducing manual effort.

Core Features & Use Cases

  • Automated bilingual README generation: Produces English and Chinese READMEs from codebases to ensure consistent documentation.
  • Multi-language support: Analyzes projects in Go, Python, JavaScript/TypeScript, PHP, and Swift for broad applicability.
  • Documentation with licensing and structure: Outputs a main README, a doc/ directory with detailed guidance, and automated license blocks when needed.

Quick Start

Run the CLI to generate bilingual READMEs for your repository.

Frequently Asked Questions about readme-generate

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate a bilingual README from source code?▼

Automated bilingual README generation analyzes source code to extract project metadata, dependencies, and file structure, producing ready-to-publish README.md and README.zh.md files to eliminate manual documentation effort.

Does automated README generation work with Python and JavaScript projects?▼

Automated README generation supports multi-language repositories including Python, JavaScript/TypeScript, Go, PHP, and Swift, analyzing language-specific types and functions to export accurate documentation.

Can I generate license blocks and architecture sections automatically?▼

Automated documentation generation outputs license blocks and architecture sections by extracting project name, version, and file structure directly from the source code during the analysis phase.

What is the best way to create consistent English and Chinese documentation?▼

Generating bilingual READMEs from codebases ensures consistent English and Chinese documentation by automatically extracting project details and outputting both README.md and README.zh.md files simultaneously.

How to generate a complete doc set including a doc directory from a codebase?▼

Code analysis for documentation generates a main bilingual README alongside a detailed doc directory structure, extracting functions and dependencies to provide comprehensive project guidance.

Do I need to manually write project structure details for automated documentation?▼

Automated documentation generation requires no manual structure input; it automatically extracts the file structure, types, and dependencies from the source code to generate the complete doc set.

Related Skills

Explore More Software Engineering Skills→
VMRam95VMRam95

agentlens

Analyze directory structures and source code to generate hierarchical documentation and architectural maps.

Community
Intermediate
causify-aicausify-ai
144

readme.create

Generate structured README.md files documenting directory contents and executable tools.

Official
Basic
sobhanashinesobhanashine
1

ship

Automate software deployment by merging branches, running tests, and updating versioning.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic