README
也叫：README.md、说明文件、自述文件
项目的说明书：这是什么、怎么装、怎么用，都写在这里。它通常是项目根目录里一个叫 README.md 的文件，GitHub 会把它直接显示在项目首页。
先知道：仓库
“项目下载下来一堆文件，我该从哪个开始看？”
README 是英文的，我看不懂怎么办？
整段复制给 AI，让它翻成中文，并按"要装什么、按什么顺序做"整理成步骤。翻完对照一下原文里的命令，命令本身不要让它改。
像家电包装盒里的那本说明书：先告诉你这是什么、盒子里有什么，再一步步教你怎么装、怎么用；装不上的时候，回去翻它比瞎试快得多。
本页有 6 节，点开跳到任意一节
一份 README 一般写这几块
- 这是什么
一两句话说清项目是干什么的，常配一张截图。
- 要准备什么
要装的运行环境和版本，比如"需要 Node.js 18 以上"。
- 怎么装、怎么跑
- 许可证
能不能商用，写在 LICENSE 里，README 末尾常会提一句。
"README.md" 末尾的 .md 是 Markdown 格式：# 是标题、* 是列表。GitHub 会自动排版成好看的样子，在记事本里打开才会看到这些符号。
用的时候要注意
可以让 AI 装，但先让它读 README、把步骤念给你听。README 里常写着"必须先做的一步"，跳过就会卡住。
项目改了、说明没跟着改的情况很常见。报错时把报错和 README 里那一步一起发给 AI（见报错与日志）。
这样跟 AI 说
这是一个项目的 README：（贴在这里）。请用大白话告诉我：这个项目是干什么的，我的电脑要先装什么、要什么版本，然后把安装和启动整理成一步步的清单。每一步写清楚要运行的命令和预期看到什么。最后标出哪一步最容易出错。
复制以后，把标出来的括号换成你自己的内容再发。
在提示词库里找更多类似的 ›考考你
准备让 AI 帮你把一个开源项目跑起来，第一步最好做什么？
接下来学什么
- 1Vibe Coding 入门 · 下一个（第 5 / 16 个）克隆把网上的整个项目，连同它的修改记录，复制一份到自己电脑上。
- 2运行环境让项目代码能在你电脑上跑起来的那个软件，最常见的是 Node.js 和 Python。
- 3安装依赖把项目要用到的、别人写好的"零件"一次装好，项目才能跑起来。
‹ 上一个：仓库 · Vibe Coding 入门第 4 / 16 个
也可以看看：GitHub、仓库、Vibe Coding
哪些词链接了我：GitHub、仓库、克隆、运行环境、安装依赖