Skip to content

Commit d9c4be8

Browse files
chore: clean up dead files (#75)
* chore: clean up dead files * feat: add index file to be searchable
1 parent 5b26065 commit d9c4be8

26 files changed

Lines changed: 247 additions & 452 deletions

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,8 @@ modules.builtin
3434
modules.builtin.modinfo
3535

3636
.venv/
37+
38+
# Python
39+
__pycache__/
40+
*.py[cod]
41+
*.egg-info/

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ find . -name "*.c" -o -name "*.h" | xargs clang-format -i
304304

305305
### 文档资源
306306

307-
- [快速开始](QUICK_START.md)
307+
- [快速开始](document/QUICK_START.md)
308308
- [项目规划](document/todo/roadmap.md)
309309
- [教程目录](document/tutorial/)
310310
- [示例代码](examples/)
@@ -314,7 +314,7 @@ find . -name "*.c" -o -name "*.h" | xargs clang-format -i
314314
#### Q: 我是一名新手,可以从哪里开始?
315315

316316
A: 我们建议从以下方式开始:
317-
1. 阅读 [快速开始指南](QUICK_START.md)
317+
1. 阅读 [快速开始指南](document/QUICK_START.md)
318318
2. 尝试构建项目
319319
3. 查看现有的 [Issues](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/issues),寻找标记为 `good first issue` 的问题
320320

QUICK_START.md

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

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
[![License](https://img.shields.io/badge/License-MIT-orange?style=flat-square)](LICENSE)
1818
[![Contributors](https://img.shields.io/github/contributors/Awesome-Embedded-Learning-Studio/imx-forge?style=flat-square)](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/graphs/contributors)
1919
[![Docker](https://img.shields.io/badge/Docker-supported%20%EF%83%8B-blue?style=flat-square)](docker/README.md)
20-
[![WSL2](https://img.shields.io/badge/WSL2-Tested%20%26%20OK-brightgreen?style=flat-square)](QUICK_START.md)
20+
[![WSL2](https://img.shields.io/badge/WSL2-Tested%20%26%20OK-brightgreen?style=flat-square)](document/QUICK_START.md)
2121
[![Kernel](https://img.shields.io/badge/Kernel-dual%20track%20(6.12.3%20%2B%207.0rc)-blue?style=flat-square)](#-为什么选择-imx-forge)
2222
[![Mainline](https://img.shields.io/badge/Mainline-migrated%20%EF%83%A0-brightgreen?style=flat-square)](#-为什么选择-imx-forge)
2323

@@ -131,7 +131,7 @@ v1.0.0 的 SD 卡启动与 UUU + UMS eMMC 启动流程,已由仓库主作者 C
131131

132132
---
133133

134-
📖 **详细配置指南**: [QUICK_START.md](QUICK_START.md)
134+
📖 **详细配置指南**: [QUICK_START.md](document/QUICK_START.md)
135135

136136
---
137137

@@ -208,7 +208,7 @@ MIT LICENSE —— 详见 [LICENSE](LICENSE)
208208

209209
## 🔗 相关链接
210210

211-
- **快速开始**: [QUICK_START.md](QUICK_START.md)
211+
- **快速开始**: [QUICK_START.md](document/QUICK_START.md)
212212
- **教程目录**: [document/tutorial/](document/tutorial/)
213213
- **项目规划**: [document/todo/todo.md](document/todo/todo.md)
214214
- **问题反馈**: [GitHub Issues](https://github.com/Awesome-Embedded-Learning-Studio/imx-forge/issues)

document/Awesome-Embedded.ico

-4.19 KB
Binary file not shown.

document/Awesome-Embedded.png

-1.34 MB
Binary file not shown.

document/QUICK_START.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -912,6 +912,19 @@ cd ../..
912912
git submodule update --remote --merge
913913
```
914914

915+
### 问题 7: 串口设备权限被拒绝(Permission denied)
916+
917+
**症状**: 访问 `/dev/ttyUSB*` 时提示 `Permission denied`,或 `picocom` 打开串口失败。
918+
919+
**原因**: 串口设备默认归属于 `dialout` 组,普通用户没有读写权限。
920+
921+
**解决方法**: 把当前用户加入 `dialout` 组:
922+
923+
```bash
924+
sudo usermod -aG dialout $USER
925+
# 需要重新登录(或执行 newgrp dialout)后生效
926+
```
927+
915928
---
916929

917930
## 下一步

document/todo/directions/d1-environment.md

Lines changed: 55 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 方向 D1:环境完善
22

3-
> **最后更新**:2026-06-07
4-
> **任务数量**:35项 (6工具 + 29文档)
3+
> **最后更新**:2026-06-14(对齐实际进度)
4+
> **任务数量**:35项 (6工具 + 29文档),P0 文档已完成 23/29
55
66
---
77

@@ -21,14 +21,14 @@
2121

2222
| 优先级 | 工具任务 | 文档任务 | 总计 |
2323
|--------|----------|----------|------|
24-
| P0 | 2项 ✅ | 29项 | 31 |
25-
| P1 | 3项 | - | 3 |
26-
| P2 | 1项 | - | 1 |
24+
| P0 | 2项 ✅ | 29项(✅23 / 待办6)| 31 |
25+
| P1 | 3项(待办)| - | 3 |
26+
| P2 | 1项(待办)| - | 1 |
2727
| **总计** | **6** | **29** | **35** |
2828

2929
---
3030

31-
## 📋 P0: 主线闭环 (21项)
31+
## 📋 P0: 主线闭环 (31项)
3232

3333
> 新用户能够从零到第一次成功启动的完整路径
3434
@@ -39,51 +39,55 @@
3939
| D1-001: Dockerfile || 容器化开发环境 |
4040
| D1-004: env-init.sh || 本地环境配置脚本 |
4141

42-
### 文档任务 (19项)
43-
44-
#### P0-0: 系统工程主线闭环 (10项)
45-
46-
| 任务 | 相关文件 |
47-
|------|----------|
48-
| [ ] Board bring-up quick start / 板子上手与硬件速查 | `document/tutorial/start/` |
49-
| [ ] First boot and serial console checklist / 第一次上电与串口检查流程 | `document/tutorial/start/` |
50-
| [ ] Boot mode and storage selection guide / 启动介质选择说明 | `document/tutorial/start/` |
51-
| [ ] Safe flashing guide / 安全烧录教程 | `document/tutorial/usage/` |
52-
| [ ] **Full build workflow from a clean clone** / 从空仓库到完整构建的主线教程 | `document/tutorial/build/` |
53-
| [ ] **`out/` directory explanation** / `out/` 目录结构说明 | `document/tutorial/build/` |
54-
| [ ] BSP default build workflow / BSP 默认构建链路说明 | `document/tutorial/build/` |
55-
| [ ] Mainline build verification workflow / mainline 构建验证链路说明 | `document/tutorial/build/` |
56-
| [ ] Patch workflow guide / patch 工作流实战说明 | `document/tutorial/build/` |
57-
| [ ] Common build failure troubleshooting / 常见构建失败排查说明 | `document/tutorial/troubleshooting/` |
58-
59-
#### P0-1: Ubuntu/Linux 基础 (新增,基于旧教程 Ch 2)
60-
61-
| 任务 | 相关文件 |
62-
|------|----------|
63-
| [ ] Linux basic commands tutorial / Linux 基础命令教程 | `document/tutorial/ubuntu/` |
64-
| [ ] Shell scripting basics / Shell 脚本编程基础 | `document/tutorial/ubuntu/` |
65-
| [ ] File system详解 / Linux 文件系统与目录结构 | `document/tutorial/ubuntu/` |
66-
| [ ] User and permission management / 用户与权限管理 | `document/tutorial/ubuntu/` |
67-
| [ ] Disk and file management / 磁盘与文件管理 | `document/tutorial/ubuntu/` |
68-
| [ ] Network configuration and debugging / 网络配置与调试 | `document/tutorial/ubuntu/` |
69-
| [ ] VIM quick start / VIM 快速入门 | `document/tutorial/ubuntu/` |
70-
| [ ] Serial port tools guide / 串口工具使用指南 | `document/tutorial/ubuntu/` |
71-
| [ ] Makefile basics / Makefile 基础与语法 | `document/tutorial/ubuntu/` |
72-
| [ ] Text editing in terminal / 终端下文本编辑 (VIM/Gedit) | `document/tutorial/ubuntu/` |
73-
74-
#### P0-1: Rootfs 与用户空间 (9项)
75-
76-
| 任务 | 相关文件 |
77-
|------|----------|
78-
| [ ] BusyBox Rootfs extension guide / BusyBox Rootfs 扩展教程 | `document/tutorial/rootfs/` |
79-
| [ ] init process explanation / init 流程说明 | `document/tutorial/rootfs/` |
80-
| [ ] mdev, fstab, network and startup scripts / mdev、fstab、网络配置与启动脚本说明 | `document/tutorial/rootfs/` |
81-
| [ ] rootfs overlay guide / rootfs overlay 使用教程 | `document/tutorial/rootfs/` |
82-
| [ ] Kernel module deployment guide / 内核模块部署教程 | `document/tutorial/rootfs/` |
83-
| [ ] Auto-loading kernel modules at boot / 内核模块开机加载说明 | `document/tutorial/rootfs/` |
84-
| [ ] Firmware and third-party library deployment / 固件与第三方库部署说明 | `document/tutorial/rootfs/` |
85-
| [ ] NFS-based development workflow / NFS 开发流说明 | `document/tutorial/rootfs/` |
86-
| [ ] Rootfs mount failure troubleshooting / Rootfs 挂载失败排查 | `document/tutorial/debug/` |
42+
### 文档任务 (29项)
43+
44+
> **2026-06-14 对齐**:P0 文档已完成 23 项,剩余 6 项(标注 ⚠️)。已完成项链接到实际文件;旧规划路径 `tutorial/ubuntu/``tutorial/usage/``tutorial/troubleshooting/``tutorial/debug/` 均不存在,内容实际落在 `linux-basics/``flash/``build/``rootfs/`
45+
46+
#### P0-0: 系统工程主线闭环 (10项 — 已完成 8)
47+
48+
| 任务 | 状态 | 实际文件 |
49+
|------|------|----------|
50+
| Board bring-up quick start / 板子上手与硬件速查 | [ ] ⚠️ | 起步引导见 [start/](../../tutorial/start/),缺「硬件接口速查表」专篇 |
51+
| First boot and serial console checklist / 第一次上电与串口检查 | [ ] ⚠️ | 部分覆盖 [practical/03_boot_and_debug](../../tutorial/practical/03_boot_and_debug.md) |
52+
| Boot mode and storage selection guide / 启动介质选择 | [x] | [flash/01 存储介质](../../tutorial/flash/01_storage_media_basics.md) + [flash/03 启动流程与偏移](../../tutorial/flash/03_imx6ull_boot_flow_and_offsets.md) |
53+
| Safe flashing guide / 安全烧录教程 | [x] | [flash/08 SD 卡烧录](../../tutorial/flash/08_sd_card_flashing.md) + [flash/09 uuu/ums emmc](../../tutorial/flash/09_uuu_ums_emmc_flashing.md) |
54+
| **Full build workflow from a clean clone** / 从空仓库到完整构建 | [x] | [practical/02 构建系统](../../tutorial/practical/02_build_system.md) |
55+
| **`out/` directory explanation** / `out/` 目录结构 | [x] | [build/01 out 目录结构](../../tutorial/build/01_out_directory_structure.md) |
56+
| BSP default build workflow / BSP 默认构建链路 | [x] | [uboot/02](../../tutorial/uboot/02_uboot_compile.md) + [kernel/02](../../tutorial/kernel/02_kernel_compile.md) + [rootfs/02](../../tutorial/rootfs/02_busybox_compile.md) |
57+
| Mainline build verification workflow / mainline 构建验证 | [x] | [kernel/mainline/](../../tutorial/kernel/mainline/)(11 篇,含 defconfig/dts 迁移/调试) |
58+
| Patch workflow guide / patch 工作流实战 | [x] | [build/02 patch 工作流](../../tutorial/build/02_patch_workflow_practice.md) |
59+
| Common build failure troubleshooting / 常见构建失败排查 | [ ] ⚠️ | 部分覆盖 [kernel/mainline/11 常见问题](../../tutorial/kernel/mainline/11_common_issues.md),缺专门构建排查篇 |
60+
61+
#### P0-1: Ubuntu/Linux 基础 (10项 — 已完成 9,基于旧教程 Ch 2)
62+
63+
> 已由 [linux-basics/](../../tutorial/linux-basics/) 35 章完整覆盖(原计划路径 `document/tutorial/ubuntu/` 已废弃)。
64+
65+
| 任务 | 状态 | 实际文件 |
66+
|------|------|----------|
67+
| Linux basic commands / Linux 基础命令 | [x] | [ch06–ch11 命令行](../../tutorial/linux-basics/02-commandline/ch06-shell.md) |
68+
| Shell scripting basics / Shell 脚本基础 | [x] | [ch26–ch30 脚本](../../tutorial/linux-basics/06-script/ch26-bash-basic.md) |
69+
| File system详解 / 文件系统与目录结构 | [x] | [ch07 目录导航](../../tutorial/linux-basics/02-commandline/ch07-navigate.md) + [ch08 文件操作](../../tutorial/linux-basics/02-commandline/ch08-fileops.md) |
70+
| User and permission management / 用户与权限 | [x] | [ch15 用户](../../tutorial/linux-basics/04-system/ch15-user.md) + [ch16 权限](../../tutorial/linux-basics/04-system/ch16-permission.md) |
71+
| Disk and file management / 磁盘与文件管理 | [x] | [ch18 磁盘](../../tutorial/linux-basics/04-system/ch18-disk.md) |
72+
| Network configuration and debugging / 网络配置与调试 | [x] | [ch21 网络配置](../../tutorial/linux-basics/05-network/ch21-netconfig.md) + [ch22 诊断](../../tutorial/linux-basics/05-network/ch22-netdiag.md) |
73+
| VIM quick start / VIM 快速入门 | [x] | [ch12 vim](../../tutorial/linux-basics/03-text/ch12-vim.md) |
74+
| Serial port tools guide / 串口工具使用 | [ ] ⚠️ | 缺:linux-basics 未含 minicom/串口工具专章 |
75+
| Makefile basics / Makefile 基础 | [x] | [ch31 gcc 与 make](../../tutorial/linux-basics/07-devtools/ch31-gcc-make.md) |
76+
| Text editing in terminal / 终端文本编辑 | [x] | [ch12 vim](../../tutorial/linux-basics/03-text/ch12-vim.md) |
77+
78+
#### P0-2: Rootfs 与用户空间 (9项 — 已完成 6)
79+
80+
| 任务 | 状态 | 实际文件 |
81+
|------|------|----------|
82+
| BusyBox Rootfs extension guide / BusyBox Rootfs 扩展 | [x] | [rootfs/02 busybox 编译](../../tutorial/rootfs/02_busybox_compile.md) |
83+
| init process explanation / init 流程说明 | [x] | [rootfs/03 inittab 与 init](../../tutorial/rootfs/03_inittab_init.md) |
84+
| mdev, fstab, network and startup scripts / mdev、fstab、启动脚本 | [x] | [rootfs/04 目录结构](../../tutorial/rootfs/04_rootfs_structure.md) |
85+
| rootfs overlay guide / rootfs overlay 使用 | [x] | [build/03 rootfs overlay](../../tutorial/build/03_rootfs_overlay_guide.md) |
86+
| Kernel module deployment guide / 内核模块部署 | [x] | [driver/modules/02 构建加载](../../tutorial/driver/modules/02_module_build_and_load.md) |
87+
| Auto-loading kernel modules at boot / 内核模块开机加载 | [ ] ⚠️ | 缺专门篇,rootfs/03 开机脚本部分涉及 |
88+
| Firmware and third-party library deployment / 固件与第三方库部署 | [x] | [driver/firmware_apply/firmware](../../tutorial/driver/firmware_apply/firmware.md) |
89+
| NFS-based development workflow / NFS 开发流 | [x] | [rootfs/05 NFS 挂载](../../tutorial/rootfs/05_nfs_wsl_troubleshoot.md) + [practical/04](../../tutorial/practical/04-nfs-experience.md) |
90+
| Rootfs mount failure troubleshooting / Rootfs 挂载失败排查 | [ ] ⚠️ | 部分覆盖 [rootfs/05](../../tutorial/rootfs/05_nfs_wsl_troubleshoot.md),缺通用排查篇 |
8791

8892
---
8993

0 commit comments

Comments
 (0)