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

Update doc

Browse Source
This commit is contained in:
Aoran Zeng
2025-03-06 08:32:37 +08:00
parent e2fd640045
commit 52212db815
5 changed files with 23 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/01-Develop.md
View File

@@ -7,7 +7,7 @@
! Contributors : Nul None <nul@none.org>
! |
! Created On : <2024-12-27>
! Last Modified : <2024-12-27>
! Last Modified : <2025-03-06>
! ---------------------------------------------------------- -->
# 开发
@@ -34,10 +34,13 @@ $ make CC=gcc # 使用 gcc 编译
```
```bash
# 编译并直接启动 GDB
# 重新编译并启动 GDB 调试
$ make debug
# 如果需要单独生成含有编译信息的二进制文件（这个不会自己启动GDB）
# 重新编译并启动 LLDB 调试
$ make debug DEBUGGER=lldb
# 如果需要单独生成含有编译信息的二进制文件（这个不会自己启动debugger）
$ make DEBUG=1
```

4
doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md
View File

@@ -7,14 +7,14 @@
! Contributors : Nul None <nul@none.org>
! |
! Created On : <2024-08-19>
! Last Modified : <2024-12-27>
! Last Modified : <2025-03-06>
! ---------------------------------------------------------- -->
# Write A Recipe Even If You Don't Know C
# 介绍
**`chsrc` 不仅是一个命令行工具，同时也是一个换源框架，它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。**
**`chsrc` 不仅是一个命令行工具，同时也是一个体现了 Ruby on Rails 思想的 MVC 换源框架，它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。**
<br>

13
doc/README.md
View File

@@ -7,14 +7,12 @@
! Contributors : Nul None <nul@none.org>
! |
! Created On : <2024-12-27>
! Last Modified : <2024-12-27>
! Last Modified : <2025-03-06>
! ---------------------------------------------------------- -->
# 文档说明
**注：这些不是用户手册，而是开发者文档**
E2E (End-to-End) 开发流程:
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)
@@ -23,6 +21,13 @@ E2E (End-to-End) 开发流程:
<br>
用户手册：
1. [chsrc.1](./chsrc.1)
2. [chsrc.texi](./chsrc.texi)
<br>
## 贡献指导
若有任何问题，可在 [GitHub discussions](https://github.com/RubyMetric/chsrc/discussions) 中询问和讨论