From 7e00a49078b67e104e3a6ea8bc831fc929181662 Mon Sep 17 00:00:00 2001 From: Aoran Zeng Date: Mon, 11 Aug 2025 04:03:01 +0800 Subject: [PATCH] Rename doc --- .github/copilot-instructions.md | 2 +- README.md | 2 +- ...-Write-A-Recipe-Even-If-You-Dont-Know-C.md} | 18 ++++++++++-------- doc/README.md | 2 +- 4 files changed, 13 insertions(+), 11 deletions(-) rename doc/{02-Write-A-Recipe-Even-If-You-Dont-Know-C.md => 10-Write-A-Recipe-Even-If-You-Dont-Know-C.md} (89%) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 70d75d7..3e43360 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -75,6 +75,6 @@ ### Important Project Concepts: -请阅读 `doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md` +请阅读 `doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md` ## Important: 一定要保持注释，因为它记录了重要的维护信息 diff --git a/README.md b/README.md index 516cf63..93f80b8 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ ## 🤝 协作与贡献 > [!TIP] -> **`chsrc` 不仅是一个命令行工具，同时也是一个体现了 Ruby on Rails 思想的 MVC 换源框架，它甚至使你能够在不了解C语言的情况下编写出新的换源方法 (recipe)。** 配合使用 [rawstr4c], 这将比写 shell 脚本更加轻松。 [Write A Recipe Even If You Don't Know C](./doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md) +> **`chsrc` 不仅是一个命令行工具，同时也是一个体现了 Ruby on Rails 思想的 MVC 换源框架，它甚至使你能够在不了解C语言的情况下编写出新的换源方法 (recipe)。** 配合使用 [rawstr4c], 这将比写 shell 脚本更加轻松。 [Write A Recipe Even If You Don't Know C](./doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md) --- diff --git a/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md b/doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md similarity index 89% rename from doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md rename to doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md index 8bf1729..45f1588 100644 --- a/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md +++ b/doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md @@ -2,12 +2,12 @@ ! SPDX-License-Identifier: GFDL-1.3-or-later ! ------------------------------------------------------------- ! Doc Type : Markdown - ! Doc Name : 02-Write-A-Recipe-Even-If-You-Dont-Know-C.md + ! Doc Name : 10-Write-A-Recipe-Even-If-You-Dont-Know-C.md ! Doc Authors : Aoran Zeng ! Contributors : Nul None ! | ! Created On : <2024-08-19> - ! Last Modified : <2025-07-21> + ! Last Modified : <2025-08-11> ! ---------------------------------------------------------- --> # Write A Recipe Even If You Don't Know C @@ -52,8 +52,6 @@ - `source`: 该 `target` 所能换的具体的源，由 `mirror` 提供服务，往往一个 `mirror` 会提供许多 `source` - `recipe`: 是为一个 `target` 定义的具体换源方法，请参考 `src` 目录中的 `recipe` 目录 -- `feature`: 一个 `target` 可以支持的功能，比如能否重置回上游默认源等 - - **镜像源**: 为了方便，**偶尔**我们将直接称`mirror`和/或`source`为**镜像源**，这只是一种方便性的称呼，可以统称二者，也可以根据上下文指代二者之一
@@ -76,17 +74,21 @@ 5. 在 [Wiki] 中记录的镜像站中寻找可用源；可以额外补充镜像站 -6. 可以使用这些函数: +6. 使用 chef DSL 定义 `_prelude()` 函数 + + 该函数将填充 target 所有的必要信息，包括维护信息、换源信息 + +7. 按需实现 `_setsrc()` `_getsrc()` `_resetsrc()`， 可以使用这些函数: 1. `framework/core.c` 中以 `chsrc_` 开头的所有函数或宏 2. `xy.h` 中以 `xy_` 开头的所有函数或宏 - 3. `chec.h` 中以 `chef_` 开头的所有函数或宏 + 3. `chec.c` `chef-helper.c` 中以 `chef_` 开头的所有函数或宏 一个简单的方法是，在 VS Code 中按快捷键 `Ctrl-T` 搜索上述三种前缀 -7. 在 `recipe/menu.c` 中添加用户可以使用的 `target` 别名 +8. 在 `recipe/menu.c` 中登记此 target -8. [编译、运行、测试 (how?)](./01-Develop.md)，若无问题可提交 Pull Request +9. [编译、运行、测试 (how?)](./01-Develop.md)，若无问题可提交 Pull Request
diff --git a/doc/README.md b/doc/README.md index f069e0a..86b7da6 100644 --- a/doc/README.md +++ b/doc/README.md @@ -15,7 +15,7 @@ E2E (End-to-End) 开发文档: 1. 开发环境准备，如何编译和测试，请参考 [./01-Develop.md](./01-Develop.md) -2. 如何编写一个具体的 recipe，请参考 [./02-Write-A-Recipe-Even-If-You-Dont-Know-C.md](./02-Write-A-Recipe-Even-If-You-Dont-Know-C.md) +2. 如何编写一个具体的 recipe，请参考 [./10-Write-A-Recipe-Even-If-You-Dont-Know-C.md](./10-Write-A-Recipe-Even-If-You-Dont-Know-C.md) 3. 直接推送还是提交 PR，请参考 [./03-CONTRIBUTING.md](./03-CONTRIBUTING.md) 4. 代码风格，请参考 [./04-为什么拒绝使用代码格式化工具.md](./04-为什么拒绝使用代码格式化工具.md)