Skip to content

Commit 9c51e8c

Browse files
committed
Update doc
1 parent d48bbc9 commit 9c51e8c

File tree

2 files changed

+11
-59
lines changed

2 files changed

+11
-59
lines changed

.github/copilot-instructions.md

Lines changed: 5 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -9,72 +9,24 @@
99

1010
- **Framework**: 在目录 `src/framework/` 中,包含了核心实现,支持 recipe
1111

12-
- `chef.c` 里实现了 chef DSL,你可以使用它来确定正确的使用方法
1312
- `struct.h` 里定义了各种数据结构和宏,这是整个 chsrc 的核心,也是 chef DSL 的核心
13+
- `chef.c` 里实现了 chef DSL,你可以使用它来确定正确的使用方法
1414

1515
- **Recipes**: 在目录 `src/recipe/` 中,包含了针对不同目标的具体实现
1616

17-
- `lang/` - 编程语言的包管理器 (Python pip, Node.js npm, 等等)
18-
- `os/` - 操作系统的包管理器 (Ubuntu apt, Arch pacman, 等等)
19-
- `ware/` - 软件工具和应用 (Docker, Homebrew, 等等)
20-
21-
22-
## 项目当前状态: chef DSL 迁移
23-
24-
项目正在进行现代化改造,从旧模式迁移到新的 "chef DSL" 模式。
25-
26-
### Recipe 新模式
27-
28-
请阅读 `src/recipe/recipe-template.c`, 每一个 recipe 都应该遵循这个模板。每一个文件都应该定义 prelude,在这个函数里
29-
30-
`chef.c` 里实现了 chef DSL,你可以使用它来确定正确的使用方法。
31-
32-
1. 填充维护者信息
33-
2. recipe 元数据
34-
3. recipe 支持的 feature
35-
4. 初始化源信息 (包括 upstream)
36-
17+
- `lang/` - 编程语言 (Ruby, JavaScript 等等)
18+
- `os/` - 操作系统 (Ubuntu, Arch Linux 等等)
19+
- `ware/` - 软件工具和应用 (Docker, Homebrew 等等)
3720

38-
### Recipe 旧模式 (To Be Removed):
39-
40-
- 文件头的注释信息
41-
- `static Source_t target_sources[]` 数组
42-
- `def_sources_n(target)`
43-
- `Feature_t target_feat()` 函数
44-
- `def_target_gsf()`
4521

4622
## Coding Guidelines
4723

48-
### When Modernizing Files:
49-
50-
1. **保持重要的技术注释** - 如对 URLs 的注释,实现备注等等
51-
52-
2. **正确转换元数据**:
53-
54-
- 提取旧头文件中的作者/贡献者信息
55-
- 保留创建日期和重要更新日期
56-
- 保留技术备注和警告
57-
- 请注意新的 Target_t 结构体
58-
59-
3. **使用 chef DSL**:
60-
61-
- `def_target()` 在文件最开头
62-
- `prelude()` 函数包含所有元数据
63-
- `def_sources_begin/end` 用于源定义
64-
65-
4. **Remove completely**:
66-
67-
- 旧的文件头部包含许可证/作者信息
68-
- `Feature_t` 函数删除
69-
- `static Source_t` 数组删除
70-
- 旧的宏调用在文件末尾删除
71-
7224
### C Coding Style:
7325

7426
请阅读 `doc/03-为什么拒绝使用代码格式化工具.md`
7527

7628
### Important Project Concepts:
7729

78-
请阅读 `doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md`
30+
请阅读 `doc/10-如何编写recipe.md`
7931

8032
## Important: 一定要保持注释,因为它记录了重要的维护信息

doc/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@
1414

1515
E2E (End-to-End) 开发文档:
1616

17-
- 开发环境准备,如何编译和测试,请参考 [./01-开发与构建](./01-开发与构建)
18-
- 直接推送还是提交 PR,请参考 [./02-提交与贡献.md](./02-提交与贡献.md)
19-
- 代码风格,请参考 [./03-为什么拒绝使用代码格式化工具.md](./03-为什么拒绝使用代码格式化工具.md)
17+
- 开发环境准备,如何编译和测试,请参考 [01-开发与构建.md](./01-开发与构建.md)
18+
- 直接推送还是提交 PR,请参考 [02-提交与贡献.md](./02-提交与贡献.md)
19+
- 代码风格,请参考 [03-为什么拒绝使用代码格式化工具.md](./03-为什么拒绝使用代码格式化工具.md)
2020

2121
<br>
2222

2323
具体 recipe 相关:
2424

25-
- 如何编写一个具体的 recipe,请参考 [./10-如何编写recipe.md](./10-如何编写recipe.md)
26-
- 如何修改换源URL、模糊/精准测速URL,请参考 [./11-如何修改URL.md](./11-如何修改URL.md)
25+
- 如何编写一个具体的 recipe,请参考 [10-如何编写recipe.md](./10-如何编写recipe.md)
26+
- 如何修改换源URL、模糊/精准测速URL,请参考 [11-如何修改URL.md](./11-如何修改URL.md)
2727

2828
<br>
2929

30-
- 关于维护者身份的说明,请参考 [./50-协作者与维护者.md](./50-协作者与维护者.md)
30+
- 关于维护者身份的说明,请参考 [50-协作者与维护者.md](./50-协作者与维护者.md)
3131

3232
<br>
3333

0 commit comments

Comments
 (0)