Back to Details

readme-generator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

README Generator

README生成器

Quick Start

快速开始

Generate a README based on project type:
bash
undefined
根据项目类型生成README：
bash
undefined

Detect 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"
undefined
ls package.json && echo "Node.js project" ||
ls setup.py pyproject.toml && echo "Python project" ||
ls go.mod && echo "Go project"
undefined

Instructions

操作步骤

Step 1: Analyze Project

步骤1：分析项目

Gather project information:
  • Project name (from package.json, pyproject.toml, etc.)
  • Description (from manifest or git)
  • Main language and framework
  • Key features (scan source files)
  • Dependencies (from manifest files)
收集项目信息：
  • 项目名称（来自package.json、pyproject.toml等文件）
  • 项目描述（来自清单文件或git）
  • 主要语言与框架
  • 核心功能（扫描源码文件）
  • 依赖项（来自清单文件）

Step 2: Select Template

步骤2：选择模板

Choose template based on project type:
TypeTemplateKey Sections
LibrarylibraryInstallation, API, Examples
CLI ToolcliInstallation, Commands, Options
Web AppwebappFeatures, Setup, Deployment
APIapiEndpoints, Authentication, Examples
根据项目类型选择模板：
类型模板核心章节
类库library安装、API、示例
CLI工具cli安装、命令、选项
Web应用webapp功能、设置、部署
APIapi端点、身份验证、示例

Step 3: Generate Core Sections

步骤3：生成核心章节

Title and Description:
markdown
undefined
标题与描述：
markdown
undefined

Project Name

Project Name

Brief one-line description of what the project does.
License Version

**Installation:**
```markdown
Brief one-line description of what the project does.
License Version

**安装：**
```markdown

Installation

Installation

```bash npm install project-name
```bash npm install project-name

or

or

pip install project-name ```

**Usage:**
```markdown
pip install project-name ```

**使用说明：**
```markdown

Usage

Usage

```javascript const project = require('project-name');
// Basic example project.doSomething(); ```
undefined
```javascript const project = require('project-name');
// Basic example project.doSomething(); ```
undefined

Step 4: Add Project-Specific Content

步骤4：添加项目专属内容

Include relevant sections:
  • Features: Bullet list of key capabilities
  • API Reference: For libraries
  • Configuration: For configurable tools
  • Examples: Real-world use cases
  • Contributing: How to contribute
  • License: License information
包含相关章节：
  • 功能：核心能力的项目符号列表
  • API参考：适用于类库
  • 配置：适用于可配置工具
  • 示例：真实使用场景
  • 贡献指南：如何参与贡献
  • 许可证：许可证信息

Step 5: Add Badges and Links

步骤5：添加徽章与链接

Common badges:
markdown
![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)
![Coverage](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)
![npm version](https://badge.fury.io/js/package-name.svg)
常见徽章：
markdown
![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)
![Coverage](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)
![npm version](https://badge.fury.io/js/package-name.svg)

README Structure

README结构

Essential Sections (all projects)

必备章节（所有项目）

  1. Title and Description
  2. Installation
  3. Quick Start / Usage
  4. License
  1. 标题与描述
  2. 安装
  3. 快速开始/使用说明
  4. 许可证

Recommended Sections

推荐章节

  1. Features - What makes it useful
  2. Documentation - Link to full docs
  3. Examples - Common use cases
  4. Contributing - How to help
  5. Support - Where to get help
  1. 功能 - 项目实用特性
  2. 文档 - 完整文档链接
  3. 示例 - 常见使用场景
  4. 贡献指南 - 参与方式
  5. 支持 - 获取帮助的渠道

Optional Sections

可选章节

  1. Requirements - System dependencies
  2. Configuration - Setup options
  3. Troubleshooting - Common issues
  4. Changelog - Recent changes
  5. Acknowledgments - Credits
  1. 系统要求 - 系统依赖项
  2. 配置 - 设置选项
  3. 故障排除 - 常见问题
  4. 更新日志 - 近期变更
  5. 致谢 - 致谢名单

Advanced

进阶内容

For detailed information, see:
  • Templates - README templates by project type
  • Best Practices - Documentation standards and style guide
如需详细信息，请查看：
  • 模板 - 按项目类型分类的README模板
  • 最佳实践 - 文档标准与风格指南