写作实战

Markdown 教程 · 第 8 章 · 6 次浏览

综合实战：给项目写 README.md。README 是项目门面，结构清晰直接影响使用体验。用本教程全部语法写一份标准 README。

README 结构

项目名 + 简介 → 截图 → 功能特性 → 环境要求 → 安装步骤 → 使用说明 → 项目结构 → 许可证。技术文档同理：标题、前提、步骤、示例、常见问题。

代码示例

# 项目名称

> 一句话介绍项目是做什么的。

## 功能特性
- 特性一
- 特性二

## 环境要求
- PHP >= 7.4
- MySQL >= 5.7

## 安装步骤
```bash
git clone https://github.com/user/project.git
cd project
composer install
```

## 使用说明
```bash
php -S localhost:8000
```
访问 http://localhost:8000

## 项目结构
```
project/
├── src/          # 源代码
├── public/       # 入口目录
└── README.md
```

## 常见问题
**Q: 报数据库连接错误？**
A: 检查 .env 里的数据库配置。

## License
MIT