Skip to content

Commit fa96d4b

Browse files
refactoize: todo refactorize
1 parent 44ff25c commit fa96d4b

119 files changed

Lines changed: 240 additions & 8189 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: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@
1010

1111
## 这是什么
1212

13-
**AwesomeQt** 是一份面向 C++ 开发者的 Qt 6 全栈教程,采用三层分级结构:
13+
**AwesomeQt** 是一套 Qt 6 中文深度教程,隶属 [Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio)
14+
15+
采用三层分级结构:
1416

1517
```
16-
入门层 → 能跑起来,理解核心概念,初步使用 API
17-
进阶层 → 掌握高级用法,写出工程级代码
18-
专家层 → 读懂 Qt 源码,理解设计模式与实现原理
18+
入门层 → 能跑起来,理解核心概念,知其然
19+
进阶层 → 懂原理,写出工程级稳健代码
20+
专家层 → 读懂 Qt 源码,每条结论带 文件:行号 证据
1921
```
2022

21-
> 本项目隶属于组织 [Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio) 的文档教程
22-
2323
---
2424

2525
## 快速开始
@@ -56,8 +56,8 @@ cd Tutorial_AwesomeQt
5656
```
5757
入门层 ██████████ 137 / 137 篇教程 · 134 个代码示例
5858
进阶层 ██████████ 134 / 134 篇教程 · 134 个代码示例
59-
专家层 ░░░░░░░░░░ 0 / 142 篇(规划中
60-
合计 ██████░░░░ 271 / 413
59+
专家层 ░░░░░░░░░░ 0 / ~101-108 篇(主力规划中,精确清单待定
60+
合计 ██████░░░░ 271 / ~372-379
6161
```
6262

6363
🚀🚀🚀 更加详细的进度:[tutorial/index.md](tutorial/index.md)
@@ -149,22 +149,6 @@ cd Tutorial_AwesomeQt
149149

150150
---
151151

152-
## 代码实例库规划
153-
154-
除了教程和控件库之外,项目还规划了完整的**代码实例库**。详见 [`todo/catalogs/`](todo/catalogs/) 目录下的规划清单:
155-
156-
| 清单 | 内容 | 条目数 |
157-
|------|------|--------|
158-
| [`todo/catalogs/01-widget.md`](todo/catalogs/01-widget.md) | 单个自定义控件(按钮/标签/输入/进度条/仪表盘/图表/表格/树/列表等,22 个分类) | 500+ |
159-
| [`todo/catalogs/02-app.md`](todo/catalogs/02-app.md) | 完整应用 Demo(开发工具/网络工具/文件工具/系统工具/图像工具/多媒体/办公/游戏等) | 200+ |
160-
| [`todo/catalogs/03-model.md`](todo/catalogs/03-model.md) | 控件组合与设计模式(窗口框架/导航布局/主题系统/表单/属性编辑器/拖拽/命令模式等) | 300+ |
161-
| [`todo/catalogs/04-qml.md`](todo/catalogs/04-qml.md) | QML 专项项目 | 100+ |
162-
| [`todo/catalogs/05-industrial.md`](todo/catalogs/05-industrial.md) | 工业级项目模板(HMI 仪表盘/SCADA 监控/车载中控等) | 规划中 |
163-
164-
代码实例统一使用 **Qt 6 + CMake** 构建,第三方依赖通过 CMake FetchContent 自动管理。
165-
166-
---
167-
168152
## 致谢
169153

170154
本项目的代码实例规划大量参考了以下开源项目和社区资源,在此致以诚挚的感谢:
@@ -216,7 +200,7 @@ cd Tutorial_AwesomeQt
216200

217201
## 贡献与反馈
218202

219-
这个教程是**动态生成**的,持续更新中
203+
这个教程持续更新中
220204

221205
如果你发现:
222206
- 错误或不准确的内容

TODO.md

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

todo/README.md

Lines changed: 21 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,34 @@
1-
# TODO 追踪系统
1+
# AwesomeQt · 待办
22

3-
本目录是 Tutorial_AwesomeQt 仓库的 TODO 追踪系统,按方向分类管理所有待办事项
3+
> 项目待办入口。按工作区分文件,翻到对应区开干。完成一项把 `[ ]``[x]` + 日期
44
5-
## 目录结构
5+
## 速览
66

77
```
8-
todo/
9-
├── catalogs/ # 内容目录(控件/应用/模式/QML/工业模板的完整规划清单)
10-
├── architecture/ # 架构和重构 TODO(001-009,P0 优先)
11-
├── content/ # 教程内容创建 TODO(010-049,P0-P1 优先)
12-
├── automation/ # CI/CD 和自动化 TODO(050-059,P0-P1 优先)
13-
├── embedded/ # 嵌入式 Qt TODO(060-069,P0-P1 优先)
14-
├── code-library/ # 控件/应用/模式实现 TODO(070-079,P0-P1 优先)
15-
├── mkdocs/ # MkDocs 优化 TODO(080-089,P1-P2 优先)
16-
├── community/ # 社区和贡献 TODO(090-094,P1-P2 优先)
17-
├── translation/ # 翻译流水线 TODO(095-098,P1-P2 优先)
18-
├── interactive/ # 交互式元素 TODO(100-103,P2 优先)
19-
└── archive/ # 已完成的 TODO 归档
8+
入门 137✅ · 进阶 134✅ · 专家 0/102(见 expert.md)· 实例库 1·~1075(首波39见 instance-library.md)· examples 271✅
209
```
2110

22-
## 优先级定义
11+
## 工作区 → 文件
2312

24-
| 级别 | 含义 | 示例 |
25-
|------|------|------|
26-
| P0 | 必须先做,阻塞其他工作 | 目录迁移、GUI 入门教程、CI 编译验证 |
27-
| P1 | 重要,影响下一阶段内容 | 嵌入式板级教程、QML 入门、构建脚本 |
28-
| P2 | 显著价值提升 | 工业模板、翻译流水线、Mermaid 增强 |
29-
| P3 | 锦上添花 | 在线沙箱、练习交互系统 |
13+
| 工作区 | 文件 | 内容 | 当下 |
14+
|---|---|---|---|
15+
| 专家层 | [expert.md](expert.md) | 102 篇源码拆解(每篇带 qt_src 行号证据) | ⚠ 01 篇落盘待核实 |
16+
| 实例库 | [instance-library.md](instance-library.md) | widget/app/model/industrial 成品 + 两套文档 | ✅ 首波39 可产 |
17+
| 基建 | [infra.md](infra.md) | P0/P0.5/P1/P4 + widget 化简 + 地基债 | ✅ 能开干 |
18+
| embedded | [embedded.md](embedded.md) | Layer1 公共基础 + Layer2 板级 | ⚠ 生产方式待定 |
19+
| 延后 | [parked.md](parked.md) | community/translation/interactive/CI门… | 不投入 |
3020

31-
## TODO 文件规范
21+
## 当下优先
3222

33-
每个 TODO 是一个独立的 Markdown 文件,使用以下 frontmatter:
23+
- 专家层:核实 01 篇落盘 → 推进后续
24+
- 实例库:status-led 改造 → 撑场批
25+
- 基建:widget/ 构建化简(决策已定、未落盘)
3426

35-
```yaml
36-
---
37-
id: XXX # 唯一编号,与文件名编号一致
38-
title: "描述性标题"
39-
category: architecture|content|automation|embedded|code-library|mkdocs|community|translation|interactive
40-
priority: P0|P1|P2|P3
41-
status: pending|in-progress|blocked|done
42-
created: YYYY-MM-DD
43-
assignee: charliechen
44-
depends_on: [] # 依赖的 TODO ID 列表
45-
blocks: [] # 被本 TODO 阻塞的 TODO ID 列表
46-
estimated_effort: small|medium|large|epic
47-
---
48-
```
49-
50-
文件体包含:目标、验收标准(可勾选)、实施说明、涉及文件、参考资料。
51-
52-
## 状态说明
53-
54-
| 状态 | 含义 |
55-
|------|------|
56-
| pending | 未开始 |
57-
| in-progress | 进行中 |
58-
| blocked | 被阻塞(等待依赖完成) |
59-
| done | 已完成 |
60-
61-
## 编号规则
62-
63-
| 范围 | 类别 | 说明 |
64-
|------|------|------|
65-
| 001-009 | `architecture/` | 架构重组、构建系统、目录结构 |
66-
| 010-049 | `content/` | 教程内容创建(按模块/层级分组) |
67-
| 050-059 | `automation/` | CI/CD、构建脚本、AI 生成流水线 |
68-
| 060-069 | `embedded/` | 嵌入式 Qt 板级教程、交叉编译 |
69-
| 070-079 | `code-library/` | 控件/应用/模式/工业模板实现 |
70-
| 080-089 | `mkdocs/` | 文档站点增强、导航、插件 |
71-
| 090-094 | `community/` | Discussions、贡献者系统、指南 |
72-
| 095-098 | `translation/` | AI 翻译流水线、双语站点 |
73-
| 100-103 | `interactive/` | 在线沙箱、图表、GIF、练习系统 |
74-
75-
## catalogs/ 目录
76-
77-
`catalogs/` 目录保存完整的规划清单,是所有代码项目的参考来源:
78-
79-
- `00-overview.md` — 项目总览和编码标准
80-
- `01-widget.md` — 537 项自定义控件清单
81-
- `02-app.md` — 200 项完整应用清单
82-
- `03-model.md` — 317 项设计模式清单
83-
- `04-qml.md` — 52 项 QML 项目清单
84-
- `05-industrial.md` — 工业级模板清单
27+
## gate
8528

86-
这些文件回答"我们最终要构建什么",而 TODO 任务文件回答"下一步做什么"。
29+
- 01 篇落盘待核实 → expert.md
30+
- embedded 生产方式待定 → embedded.md
8731

88-
## 归档
32+
## 全量实例清单(参考,非待办)
8933

90-
完成的 TODO 文件从对应分类目录移入 `archive/`,保留原始内容便于回溯。归档文件的 status 字段标记为 `done`,验收标准中已完成的项标记 `[x]`
34+
选下一波时查 [registries/](registries/)(widget 500 / app 200 / model 317 / qml 52 / industrial 6)

todo/architecture/001-tutorial-migration.md

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

todo/architecture/002-directory-structure.md

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

todo/architecture/003-qt-source-strategy.md

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

todo/architecture/004-cmake-presets.md

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

todo/architecture/005-embedded-directory.md

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

0 commit comments

Comments
 (0)