diff --git a/README.md b/README.md index 93f80b8..26b4cb5 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ! Contributors : Mikachu2333 ! | ! Created On : <2023-12-28> - ! Last Modified : <2025-07-22> + ! Last Modified : <2025-08-11> ! ---------------------------------------------------------- -->
@@ -42,12 +42,12 @@ ## 🤝 协作与贡献 > [!TIP] -> **`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) +> **`chsrc` 不仅是一个命令行工具,同时也是一个体现了 Ruby on Rails 思想的 MVC 换源框架,它甚至使你能够在不了解C语言的情况下编写出新的换源方法 (recipe)。** 配合使用 [rawstr4c], 这将比写 shell 脚本更加轻松。 [如何编写 recipe?](./doc/10-如何编写recipe.md) --- > [!NOTE] -> 这是你可以参与的第一个现实世界中有用的C语言项目,[用 VS Code 一分钟内上手编译、运行、测试 chsrc](./doc/01-Develop.md) +> 这是你可以参与的第一个现实世界中有用的C语言项目,[用 VS Code 一分钟内上手编译、运行、测试 chsrc](./doc/01-开发与构建.md) > > 欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者。[从开发到提交PR,我们覆盖全流程文档](./doc/) ,作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50) diff --git a/doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md b/doc/10-如何编写recipe.md similarity index 98% rename from doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md rename to doc/10-如何编写recipe.md index 45f1588..bf3dffb 100644 --- a/doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md +++ b/doc/10-如何编写recipe.md @@ -2,7 +2,7 @@ ! SPDX-License-Identifier: GFDL-1.3-or-later ! ------------------------------------------------------------- ! Doc Type : Markdown - ! Doc Name : 10-Write-A-Recipe-Even-If-You-Dont-Know-C.md + ! Doc Name : 10-如何编写recipe.md ! Doc Authors : Aoran Zeng ! Contributors : Nul None ! | diff --git a/doc/README.md b/doc/README.md index 86b7da6..ec59276 100644 --- a/doc/README.md +++ b/doc/README.md @@ -14,12 +14,20 @@ E2E (End-to-End) 开发文档: -1. 开发环境准备,如何编译和测试,请参考 [./01-Develop.md](./01-Develop.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) +- 开发环境准备,如何编译和测试,请参考 [./01-开发与构建](./01-开发与构建) +- 直接推送还是提交 PR,请参考 [./02-提交与贡献.md](./02-提交与贡献.md) +- 代码风格,请参考 [./03-为什么拒绝使用代码格式化工具.md](./03-为什么拒绝使用代码格式化工具.md) -- 关于维护者身份的说明,请参考 [./10-MAINTAINERS.md](./10-MAINTAINERS.md) +
+ +具体 recipe 相关: + +- 如何编写一个具体的 recipe,请参考 [./10-如何编写recipe.md](./10-如何编写recipe.md) +- 如何修改换源URL、模糊/精准测速URL,请参考 [./11-如何修改URL.md](./11-如何修改URL.md) + +
+ +- 关于维护者身份的说明,请参考 [./50-协作者与维护者.md](./50-协作者与维护者.md)