看懂别人的项目

适合谁复制本节链接

想学习某个开源项目的人、想用别人做好的工具但不知道怎么装的人、刚入门想读懂真实代码的程序员。

GitHub = 全世界最大的代码分享网站，很多免费工具和学习项目都放在上面。

开源项目 = 代码公开、任何人都能下载使用的项目。

准备什么复制本节链接

1. 在 GitHub 上找到你想看的项目页面；
2. 点页面上绿色的 Code 按钮，选 Download ZIP，下载后解压；
3. 把解压出来的文件夹加进 Codex（Add new project）。

也可以直接把项目网址发给 Codex，让它帮你下载。这需要联网，它会请求权限。

复制这段话给 Codex复制本节链接

先看懂：

我不太懂编程。请用通俗的话给我介绍这个项目：
1. 它是用来做什么的？
2. 文件夹里主要有哪些部分，各自负责什么？（只讲最重要的几个）
3. 用到了哪些技术？每个技术用一句话解释是什么。
4. 要在我的电脑上运行它，需要准备什么？

先不要修改或运行任何东西。

再跑起来：

帮我在本地把这个项目运行起来。
- 每一步先告诉我你要做什么、为什么；
- 需要安装的东西先列出来，我同意了再装；
- 运行前先检查一下有没有可疑的操作（比如删除文件、上传数据）；
- 跑起来以后告诉我怎么打开、怎么停止。

你会看到什么复制本节链接

第一段话：Codex 读项目的说明文件和代码，给你一份通俗的介绍。

第二段话：Codex 会列出需要安装的工具（比如 Node.js、Python），请求权限安装依赖，然后启动项目。如果是网页项目，它会告诉你一个地址，比如 http://localhost:3000。

依赖 = 这个项目运行时需要用到的别人写好的代码包，就像做菜要先买齐配料。

localhost = 你自己的电脑。http://localhost:3000 就是在你电脑上运行的网页，别人访问不到。

检查结果复制本节链接

1. 按 Codex 给的方法打开项目，确认能正常使用；
2. 网页项目可以在桌面应用的内置浏览器里打开预览；
3. 不用时让 Codex 停止运行，或者在集成终端里按 Ctrl+C。

集成终端 = 桌面应用里自带的命令行窗口，按 Ctrl+` 打开。不会用也没关系，让 Codex 帮你操作就行。

想再改进可以这样说复制本节链接

画一张简单的流程图（用文字表示也行），说明用户点击一个按钮后，数据在项目里是怎么流转的。

如果我想把首页的标题改成中文，需要改哪个文件？带我一起改。

这个项目里最值得初学者学习的三段代码是哪些？逐行给我讲解。

常见问题复制本节链接

参考资料复制本节链接

• Prompting Codex：Explain a codebase（官方）
• Integrated terminal（官方）
• Built-in browser（官方）