← FC Coder · HomePhase 05 · Lesson 58 · 60 min
Lesson58
Phase Five · Showcase · Matchday 58 · The Front Page

README 三视角
家人 · 开发者 · 你自己

Today's 3 Jobs · 今天这三件事
  1. 01
    README 三段 · 家人 / 开发者 / 自己
    三读者
  2. 02
    在线玩链接 + 演示视频
    GitHub 第一眼
  3. 03
    🌟 push GitHub 看 rendered
    真效果

README 是 GitHub 第一眼。三视角:家人(我能玩)· 开发者(怎么跑)· 你自己(半年后忘了怎么改)。每段独立写。AI 加 Acknowledgements 节。

Concept

三视角写作

三段
// 三段独立 · 不混着写
家人
这是什么 + 在线玩链接 + 视频
开发者
pnpm install + 技术栈
自己
代码组织 + 决策日志
Half 2

写 · push · 验证

01写三段
01Min

打开 / 创建 README.md

标题 + 引用一句话。
02Min

第 1 段:这是什么(给家人)+ 链接

在线玩 + 演示视频。
03Min

第 2 段:跑起来 + 技术栈(给开发者)

pnpm install / dev · 列技术栈。
04Min

第 3 段:代码组织(给你自己)

app/lib/components/docs 目录树。
02GitHub 验证 + AI
05Min

AI Trust:加 Acknowledgements 段

Cmd+K · '加 Acknowledgements · 爸爸 · Vercel · ai-elements 等'。
06Min

push GitHub · 看 rendered

首页第一眼。
07Min

📸 截图 README on GitHub

Phase 5 第 3 张。
讲给爸爸听

3 题

01三视角 = ?Hint ↓

家人 · 开发者 · 你自己半年后。

02README 重要吗?Hint ↓

重要 · GitHub 第一眼。开发者按它决定要不要 clone。

03怎么测写得好?Hint ↓

给爸爸看 30 秒 · 他懂吗?

温度计

评分

今天难度Difficulty
0
今天开心Fun
0
Final Whistle · 终场哨

README 立起来 —— GitHub 第一眼有了。

7 步没打勾。

Next · Lesson 59 · CI