Skip to content

Commit 42cceb5

Browse files
feat: optimize the sites (#72)
1 parent 73463b0 commit 42cceb5

143 files changed

Lines changed: 744 additions & 945 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@ v1.0.0 的 SD 卡启动与 UUU + UMS eMMC 启动流程,已由仓库主作者 C
139139

140140
| 阶段 | 主题 | 内容 | 状态 |
141141
|------|------|------|------|
142+
| 🌱 | [Linux 基础预备营](document/tutorial/linux-basics) | 零基础?35 章 Ubuntu 实用教程,补齐嵌入式必备 Linux 功课 | ✅ 新增 |
142143
| 0️⃣ | [Docker 基础](document/tutorial/docker) | Docker 基础知识与 IMX-Forge 开发指南 ||
143144
| 1️⃣ | [工具链](document/tutorial/start) | ARM GNU Toolchain 15.2 安装与配置 ||
144145
| 2️⃣ | [U-Boot](document/tutorial/uboot) | U-Boot 原理、编译、移植、Logo 定制 ||

document/.chapter-template.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# 教程章节写作模板(贡献者参考)
2+
3+
> 本文件以 `.` 开头,不会出现在站点侧边栏,仅供作者撰写新章节时对照,保持全站「学习契约」风格一致。
4+
5+
## 推荐章节结构(从上到下)
6+
7+
1. **frontmatter**(可选):`title: 章节标题`。缺失时侧边栏回退使用 H1。
8+
2. **页面头**(section 落地页用):`<PageHeader icon="🔧" title="..." description="一句话主题" />`
9+
3. **学习契约**(每篇正文开头都加,这是全站统一要求):
10+
- `::: info 本节你将学到` —— 列 3–5 条「学完后能掌握的能力」,用动词开头。
11+
- `::: tip 前置知识 · 环境` —— 前置章节链接、所需基础、软硬件环境。
12+
4. **H1 与正文**:口语化、多比喻、可读性强是本项目的风格,请保持。
13+
5. **延伸**(可选):`::: details 延伸阅读 / 常见问题` 放外部权威链接。
14+
6. **继续学习**(可选):`<ChapterNav variant="sub">` + `<ChapterLink>` 的「上一章 / 下一章」。
15+
16+
## 命名规范
17+
18+
- 章节文件统一「数字前缀 + 下划线」:`01_introduction.md``02_build_and_test.md`
19+
- section 落地页统一命名为 `index.md`,并使用 `<PageHeader>` + `<ChapterNav>`
20+
- 同一 section 内只保留一条主线,避免与其它 section 内容重复(参考设备树教程合并的经验)。
21+
22+
## 何时该建新 section
23+
24+
当一个主题超过 ~8 篇、或需要独立的「阶段/难度」划分时,新建一个 `NN_topic_name/` 目录并补 `index.md`;否则在现有 section 内追加编号章节即可。

document/QUICK_START.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@
1616

1717
---
1818

19+
## 📸 实测成果
20+
21+
> 项目已在正点原子阿尔法 i.MX6ULL 开发板上完成 SD 卡启动与 UUU + UMS eMMC 启动的实测。完整的串口启动日志见下方 [验证成功](#验证成功) 章节。
22+
23+
**开发板 LCD 点屏实测** —— 系统启动后成功点亮 7 寸 LCD(1024×600):
24+
25+
![i.MX6ULL 开发板 LCD 点屏实拍](/lcd-on.jpg)
26+
27+
**主线内核 Linux 7.0rc 启动实测** —— 上游主线内核已在板子上跑起来(对应文中的「双轨内核策略」):
28+
29+
![主线内核 Linux 7 启动实拍](/linux7.png)
30+
31+
---
32+
1933
## 开发方式选择
2034

2135
在开始之前,请选择适合您的开发方式:
@@ -316,28 +330,25 @@ imx-forge/
316330
│ ├── linux_mainline/ # Linux Kernel 上游主线
317331
│ ├── busybox/ # BusyBox
318332
│ └── qt-compile-pipeline/ # QT 交叉编译流水线
319-
├── patches/ # 补丁文件
320-
│ ├── linux-imx/
321-
│ ├── linux-mainline/
322-
│ └── uboot/
323-
├── driver/ # 设备树和驱动
324-
│ ├── device_tree/
325-
│ └── alpha-board/ # 正点原子阿尔法板配置
326-
│ ├── base_driver/ # 基础驱动框架
327-
│ ├── led/ # LED 驱动示例
328-
│ └── firmwares/ # 固件
333+
├── patches/ # 补丁文件(按轨道分目录)
334+
│ ├── linux-imx/ # NXP BSP 内核补丁
335+
│ ├── linux_mainline/ # 主线内核补丁
336+
│ └── uboot-imx/ # U-Boot 补丁
337+
├── driver/ # 驱动源码与板级设备树
338+
│ ├── device_tree/alpha-board/ # 板级设备树(.dts)
339+
── base_driver/ # 基础驱动框架
340+
│ ├── example-driver/ # 示例驱动
341+
│ ├── firmwares/ # 固件
342+
│ └── NN_tutorial_*/ # 各驱动教程对应源码(LED/按键/蜂鸣器…)
329343
├── examples/ # 示例工程
330-
│ ├── qt/ # QT 应用示例
331-
│ ├── driver/ # 驱动示例
332-
│ ├── system/ # 系统示例
333-
│ └── project/ # 完整项目示例
344+
│ └── qt/ # QT 应用示例
334345
├── rootfs/ # 根文件系统
335-
│ ├── nfs/ # NFS 挂载用 rootfs
346+
│ ├── src/ # rootfs 构建源
336347
│ └── overlay/ # Overlay 叠加目录
337348
├── out/ # 编译输出目录
338349
├── develop/ # 开发工具
339350
├── tools/ # 辅助工具
340-
└── document/ # 文档和教程
351+
└── document/ # 文档和教程(本网站源文件)
341352
```
342353

343354
> **Docker 用户注意**: Docker 镜像已包含工具链,无需手动安装 ARM GNU Toolchain。但项目仍需要克隆子模块以获取 U-Boot、Linux 内核等源码。

document/architecture/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: 架构
3+
---
4+
15
<PageHeader icon="🏛️" title="架构文档" description="深入了解 IMX-Forge 的设计和实现" />
26

37
<ChapterNav>

document/ci/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: CI/CD
3+
---
4+
15
<PageHeader icon="🔄" title="CI/CD 文档" description="IMX-Forge 项目采用分层 CI 策略,平衡验证速度和完整性" />
26

37
## 工作流概览

document/development/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: 开发指南
3+
---
4+
15
<PageHeader icon="🛠️" title="开发指南" description="开发 IMX-Forge 相关的工具和指南" />
26

37
<ChapterNav variant="sub">

document/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ hero:
2020
link: https://github.com/Awesome-Embedded-Learning-Studio/imx-forge
2121

2222
features:
23+
- icon: 🐧
24+
title: 零基础?从 Linux 基础开始
25+
details: 35 章 Ubuntu 实用教程,从命令行到交叉编译,专为嵌入式开发预备营打造,无缝衔接本教程
26+
link: /tutorial/linux-basics/
2327
- icon: 🐳
2428
title: 开箱即用的开发环境
2529
details: 预装 ARM GNU Toolchain 15.2,Docker 一键部署,WSL2 深度友好
@@ -48,4 +52,8 @@ features:
4852
title: 常见问题
4953
details: 收录 Issue 答疑记录,快速解决常见问题
5054
link: /qa/
55+
- icon: 🤝
56+
title: 参与贡献
57+
details: 补丁命名规范、Issue/PR 引导、教程写作指南,欢迎一起完善项目
58+
link: /team/
5159
---

document/modules/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: 功能模块
3+
---
4+
15
<PageHeader icon="📖" title="参考手册" description="IMX-Forge 相关的参考文档" />
26

37
<ChapterNav variant="sub">

document/notes/2026-06-08-sd-card-flashing-bringup.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: SD 卡烧录 Bring-up 实测
3+
---
4+
15
# 2026-06-08 SD Card Flashing Bring-up Note
26

37
## Goal

document/notes/2026-06-08-uuu-ums-emmc-bringup.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: UUU + UMS eMMC Bring-up 实测
3+
---
4+
15
# 2026-06-08 UUU + UMS + eMMC Bring-up Note
26

37
## Goal

0 commit comments

Comments
 (0)