github-mirror/chsrc
github-mirror/chsrc
2
0
Fork 0
mirror of https://github.com/RubyMetric/chsrc.git synced 2025-03-14 16:45:13 +08:00
Code Issues Actions 7 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
No known key found for this signature in database
GPG Key ID: 8F8BA8488E10ED98
5 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile
View File

@ -6,10 +6,10 @@
# Contributors : Yangmoooo <yangmoooo@outlook.com>
# |
# Created On : <2023-08-28>
# Last Modified : <2024-12-27>
# Last Modified : <2025-03-06>
# --------------------------------------------------------------
CFLAGS += -Iinclude -Ilib # -Wall
CFLAGS += -Iinclude -Ilib
# 只有Windows会定义该变量
ifeq ($(OS), Windows_NT)
@ -32,6 +32,8 @@ _C_Warning_Flags := $(WARN)
Target = chsrc
CI_Build_Name = chsrc
DEBUGGER = gdb
#=======================
all:
@ -43,7 +45,7 @@ CI: all
debug: CFLAGS += -g
debug: all
@gdb ./chsrc
@$(DEBUGGER) ./chsrc
test: test-xy test-fw

2
README.md
View File

@ -26,7 +26,7 @@
## 🤝 协作与贡献
> [!TIP]
> **`chsrc` 不仅是一个命令行工具，同时也是一个换源框架，它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。** 给新软件添加换源方法总共分几步？[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)。** [Write A Recipe Even If You Don't Know C](./doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md)
> [!NOTE]
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分，回报是得到其他所有领域专家的帮助**。欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者参与贡献。[从开发到提交贡献，我们覆盖全流程文档](./doc/)

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) 中询问和讨论