# Project Title
Project Introduction/Subtitle

## Project Introduction
- Project Overview
- Core Features
- Tech Stack

## Feature List
| Feature Name | Description | Status |
|---------|------|------|

## Installation Instructions
### Environment Requirements
### Installation Steps

## Usage Instructions
### Quick Start
### Configuration Instructions
### Usage Examples

## Project Structure

## Usage Methods

### Method 1: Interactive Generation

Directly submit your request, and the system will guide you to provide necessary information:

### Method 2: Automatic Generation Based on Existing Projects

The system will automatically analyze:
- Project structure (directories, files)
- Tech stack (package.json, go.mod, pom.xml, etc.)
- Build scripts (Makefile, build.sh)
- Configuration files
- Existing documentation

### Method 3: Quick Generation Using Templates

Available templates:
- `basic` - Basic template
- `full` - Complete template (includes all sections)
- `minimal` - Minimalist template
- `library` - Template for libraries/SDKs
- `webapp` - Web application template
- `cli` - CLI tool template
- `api` - API service template

## Document Structure Explanation

### Mandatory Sections

| Section | Description | Priority |
|------|------|--------|
| Project Title | Clear project name and subtitle | P0 |
| Project Introduction | One-sentence description of the project's core value | P0 |
| Feature List | Main features listed in table format | P0 |
| Installation Instructions | Environment requirements and installation steps | P0 |
| Usage Instructions | Quick start and basic usage | P0 |
| License | Open-source license declaration | P0 |

### Recommended Sections

| Section | Description | Applicable Scenarios |
|------|------|----------|
| Project Structure | Directory tree display | Medium and large-sized projects |
| Tech Stack | Technology selection explanation | All projects |
| Development Guide | Local development, build, contribution | Open-source projects |
| FAQ | Frequently asked questions | User-facing projects |
| Documentation Links | External documentation links | Complex projects |

### Optional Sections

| Section | Description | Applicable Scenarios |
|------|------|----------|
| Author Contact | WeChat, email | Personal projects |
| Technical Communication Group | Group QR code | Community projects |
| Donation | Payment QR code | Personal open-source projects |
| Project Statistics | Code volume, version history | Mature projects |
| Roadmap | Future plans | Active projects |
| Star History | Star trend chart | GitHub projects |

## Content Specifications

### Title Specifications

### Feature List Table Specifications

```markdown
## Feature List

| Feature Name | Feature Description | Tech Stack | Update Date | Version |
|---------|---------|--------|----------|------|
| Feature 1 | Description | Go | 2025-01-23 | v1.0.0 |
| Feature 2 | Description | Vue | 2025-01-23 | v1.0.0 |

## Installation Instructions

### Environment Requirements

- Node.js 16+
- Python 3.8+
- Go 1.19+

### Installation Steps

```bash
# Clone the project
git clone https://github.com/user/repo.git

# Install dependencies
npm install

# Configure
cp .env.example .env

# Start
npm run dev

### FAQ Specifications

```markdown
## FAQ

<details>
<summary>What to do if installation fails?</summary>

1. Check network connection
2. Try using domestic mirrors
3. Clear cache and reinstall

</details>

<details>
<summary>How to configure xxx?</summary>

Detailed configuration instructions...

</details>

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Version](https://img.shields.io/badge/version-v1.0.0-green.svg)
![Stars](https://img.shields.io/github/stars/user/repo.svg)

## Star History

If you find the project useful, please give it a Star ⭐

[![Star History Chart](https://api.star-history.com/svg?repos=user/repo&type=Date)]

# My Project

A concise project description

## Feature List

| Feature | Description |
|------|------|
| Feature A | xxx |
| Feature B | xxx |

## Installation

```bash
npm install

import { MyProject } from 'my-project'

const app = new MyProject()
app.run()

### Complete Template Output

Complete documentation including all recommended and optional sections.

## Template Files

### templates/basic.md
Basic project template, includes core sections

### templates/full.md
Complete project template, includes all sections

### templates/library.md
Template dedicated to libraries/SDKs

### templates/webapp.md
Template dedicated to web applications

### templates/cli.md
Template dedicated to CLI tools

### templates/api.md
Template dedicated to API services

## Sample Projects

Check the `examples/` directory for README examples of different project types:
- `examples/basic-readme.md` - Basic example
- `examples/full-readme.md` - Complete example
- `examples/library-readme.md` - Library example
- `examples/webapp-readme.md` - Web application example

## Best Practices

### README Writing Principles

1. **Simplicity First**: Display core information on the first screen
2. **Combine Text and Images**: Appropriately use screenshots and architecture diagrams
3. **Code Highlighting**: Label the language for all code blocks
4. **Version Information**: Clearly state minimum version requirements
5. **Timely Updates**: Maintain synchronization with project updates

### Image Specifications

- Store using image hosting or GitHub repository
- Image size < 500KB
- Recommended PNG/JPG formats
- Add alt text

### Link Specifications

- Use relative paths to link internal documents
- Use absolute paths to link external resources
- Add badges to important links

## Troubleshooting

### Common Issues

**Q: Garbled Chinese characters in generated README**
A: Ensure the file is saved with UTF-8 encoding

**Q: Table display is abnormal**
A: Check table alignment and ensure consistent column counts in each row

**Q: Images fail to display**
A: Confirm the image URL is accessible and use HTTPS

**Q: Directory link jump fails**
A: Ensure anchor names match titles, replace spaces with `-`

## Version History

- v1.0.0 (2025-01-23) - Initial version, supports basic template generation