diff --git a/Makefile b/Makefile index 8785fcd..73c9d80 100644 --- a/Makefile +++ b/Makefile @@ -6,10 +6,10 @@ # Contributors : Yangmoooo # | # 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 diff --git a/README.md b/README.md index 45a6c25..49d5505 100644 --- a/README.md +++ b/README.md @@ -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/) diff --git a/doc/01-Develop.md b/doc/01-Develop.md index 88385cc..403a16b 100644 --- a/doc/01-Develop.md +++ b/doc/01-Develop.md @@ -7,7 +7,7 @@ ! Contributors : Nul None ! | ! 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 ``` diff --git a/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md b/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md index f5d21f0..67dc2a8 100644 --- a/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md +++ b/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md @@ -7,14 +7,14 @@ ! Contributors : Nul None ! | ! 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)。**
diff --git a/doc/README.md b/doc/README.md index 292725c..8d3decd 100644 --- a/doc/README.md +++ b/doc/README.md @@ -7,14 +7,12 @@ ! Contributors : Nul None ! | ! 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) 开发流程:
+用户手册: + +1. [chsrc.1](./chsrc.1) +2. [chsrc.texi](./chsrc.texi) + +
+ ## 贡献指导 若有任何问题,可在 [GitHub discussions](https://github.com/RubyMetric/chsrc/discussions) 中询问和讨论