README.md 是项目的门面说明书，别人打开仓库第一眼就看这个。
核心内容：
① 项目介绍——这是啥
② 怎么跑——安装步骤
③ 目录结构——每个文件夹干嘛的
④ 技术栈——用了什么
坑：README 要用 Markdown 语法、别空着不写、写清楚怎么跑起来。
点下面任意一张小卡片，看这个符号"写出来长啥样"：
# 一级标题 ← # 号 + 空格，字最大最粗
## 二级标题 ← 两个 #，小一号
### 三级标题 ← 三个 #，再小一号
- 第一条列表 ← 短横线 + 空格，就是小圆点
- 第二条
1. 第一步 ← 数字 + 点 + 空格，自动编号
2. 第二步
[点我去Gitee](https://gitee.com) ← 中括号写要显示的字，圆括号写网址
 ← 开头加个感叹号，就是插图
**加粗的字** ← 两个星号包起来
*斜着的字* ← 一个星号包起来
```javascript ← 三个反引号包代码，还能在后面写语言名
console.log("hello");
``` ← 结尾再来三个反引号
| 写哪块 | 写啥 |
|---|---|
| 1. 标题 + 一句话 | 项目叫啥、一两句话说清是干嘛的 |
| 2. 有啥功能 | 用列表列出来：能登录、能购物车…… |
| 3. 用了啥技术 | 前端用了啥框架、啥工具 |
| 4. 怎么跑起来 | 怎么下载、怎么装依赖、怎么启动 |
| 5. 举个例子 | 放张截图或一小段代码 |
| 6. 文件夹结构 | 主要文件夹都是干啥的 |
| 7. 怎么帮忙 | 开源项目怎么提建议 |
| 8. 许可证 | 用啥开源协议（比如 MIT） |
# 一个最小 README 模板 # 我的项目名 ← 这是一级标题 一句话说清这个项目是干嘛的。 ← 下面这行就是项目简介 ## 有啥功能 ← 二级标题 - 功能一：用户能注册登录 ← 短横线列表 - 功能二：能看商品列表 ## 怎么跑起来 ← 二级标题 git clone <仓库地址> ← 先把整个项目拷到自己电脑 cd 项目目录 ← 进入项目文件夹 npm install ← 装依赖 npm run dev ← 启动，就能在浏览器看了
如果你偷懒不写 README，会怎样？因为几个月后你自己回来看项目，也想不起来当时咋想的。README 其实也是写给未来的自己的备忘录。
① 在哪用：项目第一次传到 Gitee 时，顺手写个 README 放在根目录。
② 常见坑：项目没 README，别人点开仓库一脸懵；Markdown 的 # 或 - 后面忘了打空格，符号就不生效。
③ 怎么解决：照本页八大板块填，记住 # 后、- 后都要空一格。
| 命令 | 作用 | 常用参数 | 说明 | 代码示例 |
|---|---|---|---|---|
| git clone <仓库地址> | 整个拷 | 仓库地址 | 第一次把别人项目下到自己电脑 | git clone https://gitee.com/你的用户名/my-web.git |
| cd 目录名 | 进目录 | 目录名 | 进入刚拷下来的项目文件夹 | cd my-web |
| npm install | 装依赖 | — | 下载项目要用的工具包 | npm install |
| npm run dev | 启动 | — | 跑起来，浏览器里就能看 | npm run dev |