study/chsrc
1
0
Fork 0
mirror of https://github.com/RubyMetric/chsrc synced 2025-08-12 23:27:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Rename doc

Browse Source
This commit is contained in:
Aoran Zeng 2025-08-11 04:14:35 +08:00
parent 8531a2c80e
commit 8e066b6d5b
No known key found for this signature in database
GPG Key ID: 8F8BA8488E10ED98
3 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -7,7 +7,7 @@
! Contributors : Mikachu2333 <mikachu.23333@zohomail.com>
! |
! Created On : <2023-12-28>
! Last Modified : <2025-07-22>
! Last Modified : <2025-08-11>
! ---------------------------------------------------------- -->
<div align="center">
@ -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)

2
doc/10-Write-A-Recipe-Even-If-You-Dont-Know-C.md → doc/10-如何编写recipe.md
View File

@ -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 <ccmywish@qq.com>
! Contributors : Nul None <nul@none.org>
! |

18
doc/README.md
View File

@ -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)
<br>
具体 recipe 相关:
- 如何编写一个具体的 recipe，请参考 [./10-如何编写recipe.md](./10-如何编写recipe.md)
- 如何修改换源URL、模糊/精准测速URL，请参考 [./11-如何修改URL.md](./11-如何修改URL.md)
<br>
- 关于维护者身份的说明，请参考 [./50-协作者与维护者.md](./50-协作者与维护者.md)
<br>