Skip to content

Commit d0df282

Browse files
feat: clean repos
1 parent a9a8518 commit d0df282

14 files changed

Lines changed: 348 additions & 318 deletions

File tree

BLOBS.md

Lines changed: 0 additions & 79 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ rk-forge is mainline-first board-enablement for RK3506. Before contributing:
1919
- **Commits**: conventional `type(scope): subject`, signed-off (`git commit -s`).
2020
- **C/C++ style**: `.clang-format` is authoritative.
2121

22-
## Out of scope (v1)
23-
Distro images, multi-SoC, original kernel drivers, Docker/CI multi-track, GUI, VitePress
24-
site, Python CLI (iteration 2). See [PLAN.md](PLAN.md).
22+
## Scope
23+
24+
rk-forge 是 RK3506 的主线优先板级使能(board enablement)+ 教程,**不是**发行版镜像。当前范围内:RK3506B(单 SoC)、主线 Linux + U-Boot、有序补丁整合(integrator,不写原创内核驱动)、SPI-NAND(UBIFS)与 SD 卡双启动、buildroot 最小 rootfs、VitePress 文档站。
25+
26+
明确不做:发行版镜像、多 SoC、原创内核驱动、blob 纯洁主义(`rkbin` 先用、文档化、追踪消除,见 [document/blobs.md](document/blobs.md))。完整定位与已验证能力见 [README.md](README.md)

PLAN.md

Lines changed: 0 additions & 125 deletions
This file was deleted.

QUICK_START.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,56 @@
1-
# QUICK_START
1+
# 快速开始
22

3-
Fast path. For the full learning path see [document/tutorial/boot/](document/tutorial/boot/).
3+
最短路径:把 RK3506 主线系统从源码构建到可烧 `update.img`。完整学习路径见 [document/tutorial/](document/tutorial/),在线文档见 <https://awesome-embedded-learning-studio.github.io/rk-forge/>
44

5-
## 1. Check your host
5+
## 1. 检查 host
66

77
```bash
88
./scripts/doctor.sh
99
```
1010

11-
It probes the cross toolchain (`arm-linux-gnueabihf`) and build deps, detects WSL2,
12-
and — if anything's missing — prints the exact `sudo apt install ...` line to stdout.
13-
**We never auto-install** (keeps the script Python-wrap-able).
11+
探测交叉工具链(`arm-linux-gnueabihf`)和构建依赖、检测 WSL2,缺什么就打印精确的 `sudo apt install ...`**绝不自动安装**(保持脚本可被 Python 包裹)。
12+
13+
全新 WSL2 环境通常需要:
1414

15-
On a fresh WSL2 box you'll typically need:
1615
```bash
1716
sudo apt install gcc-arm-linux-gnueabihf device-tree-compiler bison flex cpio \
18-
qemu-system-arm u-boot-tools libssl-dev libncurses-dev python3-pyelftools
17+
u-boot-tools libssl-dev libncurses-dev python3-pyelftools
18+
```
19+
20+
> 本项目深度 WSL2 友好(Mirrored 网络模式可直通开发板,USB 设备直通用于烧录/串口)。
21+
22+
## 2. 导出工具链环境(每个 shell)
23+
24+
```bash
25+
source scripts/env-setup.sh # 设置 ARCH=arm, CROSS_COMPILE=arm-linux-gnueabihf-
1926
```
2027

21-
## 2. Export the toolchain env (per shell)
28+
## 3. 一条命令构建
2229

2330
```bash
24-
source scripts/env-setup.sh # sets ARCH=arm, CROSS_COMPILE=arm-linux-gnueabihf-
31+
bash scripts/forge.sh all # setup → build → pack → assemble(默认 NAND,带首启置备)
2532
```
2633

27-
## 3. (Week 3+) Fetch sources & apply patches
34+
`forge` 是单一入口编排器,按 DAG 跑各 stage,输入没变的 stage 用内容哈希跳过。常用子命令:
2835

2936
```bash
30-
git submodule update --init --depth 1 third_party/uboot
31-
cd third_party/uboot && ../../scripts/apply-series.sh --component uboot --check
37+
bash scripts/forge.sh setup # 拉源码树 + WiFi 驱动 + 应用补丁库(git am)
38+
bash scripts/forge.sh build # 编 kernel(uboot / buildroot 单独触发,会打印命令)
39+
bash scripts/forge.sh pack # 打 loader + FIT + stage/ubifs rootfs
40+
bash scripts/forge.sh pack-sd # 打可启动 SD 卡镜像(复用 NAND pack 产物)
41+
bash scripts/forge.sh assemble --sd # 组 RKFW SD 卡 update.img(本板 ROM 只认 RK-tool 卡)
42+
bash scripts/forge.sh assemble --nand # 组 NAND update.img
43+
bash scripts/forge.sh status # 哪些 stage 是最新
44+
bash scripts/forge.sh clean --full # 干净重建
3245
```
3346

34-
`--check` is a true dry-run (applies then reverts), so it verifies the **whole
35-
ordered series** applies cleanly before you build.
47+
> **zsh 用户**:始终用 `bash scripts/forge.sh ...` 调用——lib 脚本依赖 `BASH_SOURCE`,在 zsh 下为空。
48+
49+
产物落在 `board/aes/out/update.img`
50+
51+
## 4. 烧录 & 上板
3652

37-
## 4. Build & flash — see the tutorial
53+
- **SD 卡**`forge assemble --sd` 出的镜像用 Rockchip SD 卡工具写入(本板 ROM 只从 RK-tool 卡启动,裸 `dd` 的 SD 不认)。
54+
- **NAND**:Windows 用 RKDevTool,或 Linux 用 `rkdeveloptool`(Maskrom 模式)。
3855

39-
U-Boot → kernel → SD flash is walked step-by-step in
40-
`document/tutorial/boot/{02_uboot_rkbin,03_kernel_to_console}.md` (drafted as the
41-
board DT lands).
56+
烧录、上电引导、UART 抓 log 的逐步操作见 [document/tutorial/boot/](document/tutorial/boot/)[document/tutorial/sd-boot/](document/tutorial/sd-boot/)

0 commit comments

Comments
 (0)