From a2851d5246ff6dfd08d2f031632efea24c8fe45d Mon Sep 17 00:00:00 2001 From: Aoran Zeng Date: Thu, 19 Jun 2025 21:34:01 +0800 Subject: [PATCH] Update doc --- README.md | 17 +++++++++++------ doc/01-Develop.md | 23 ++++++++++++++++++++--- doc/chsrc.1 | 2 +- doc/chsrc.texi | 6 +++--- 4 files changed, 35 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 85416eb..54892de 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ ! ------------------------------------------------------------- ! Doc Type : Markdown ! Doc Name : README.md - ! Doc Authors : Aoran Zeng - ! Contributors : Nul None + ! Doc Authors : Aoran Zeng + ! Contributors : Mikachu2333 ! | ! Created On : <2023-12-28> - ! Last Modified : <2025-06-18> + ! Last Modified : <2025-06-19> ! ---------------------------------------------------------- -->
@@ -39,13 +39,18 @@ > [!TIP] > **`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/) -，另外作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50) +> 这是你可以参与的第一个现实世界中有用的C语言项目！不再是枯燥的数据结构习题，不用再面对二十年前古老界面的 **Dev-C++**，[用 VS Code 一分钟内搭建环境编译、运行、测试、Debug chsrc !](./doc/01-Develop.md) +> +> 欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者。[从开发到提交PR，我们覆盖全流程文档](./doc/) +，作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50) --- + > [!IMPORTANT] -> [招募 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130) +> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分，回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者！](https://github.com/RubyMetric/chsrc/issues/130)
diff --git a/doc/01-Develop.md b/doc/01-Develop.md index 27f4cf7..52a5bf9 100644 --- a/doc/01-Develop.md +++ b/doc/01-Develop.md @@ -7,14 +7,28 @@ ! Contributors : Nul None ! | ! Created On : <2024-12-27> - ! Last Modified : <2025-03-06> + ! Last Modified : <2025-06-19> ! ---------------------------------------------------------- --> # 开发 -## 环境 +## 开发环境 -请安装好 `GCC` 或 `Clang` 和 `make` 以及 `curl` +请安装好： + + 1. `GCC` 或 `Clang` + 2. [just] 或 `make` + 3. `curl` + +**我推荐你使用 VS Code 开发，你可以在一分钟内成功编译、运行和 Debug `chsrc`** + + 1. `Ctrl-Shift-B` 直接构建 + 2. `F5` 直接开始 Debug + +
+ + +## 准备 ```bash # 请务必使用 dev 分支开发 @@ -25,6 +39,7 @@ $ git clone https://gitee.com/RubyMetric/chsrc.git -b dev
+ ## 编译运行 ```bash @@ -63,3 +78,5 @@ make clean 关于分支的说明以及如何提交代码，请参考 [./03-CONTRIBUTING.md](./03-CONTRIBUTING.md)
+ +[just]: https://github.com/casey/just diff --git a/doc/chsrc.1 b/doc/chsrc.1 index 6b68e19..d69c5ec 100644 --- a/doc/chsrc.1 +++ b/doc/chsrc.1 @@ -9,7 +9,7 @@ .\" Last Modified : <2025-06-16> .\" -------------------------------------------------------------- -.TH chsrc 1 "2025-06-16" "v0.2.1.1" "RubyMetric chsrc" +.TH chsrc 1 "2025-06-16" "v0.2.1.2" "RubyMetric chsrc" .SH NAME chsrc - Change Source for every software on every platform from the command line diff --git a/doc/chsrc.texi b/doc/chsrc.texi index 12acf14..e9b42e9 100644 --- a/doc/chsrc.texi +++ b/doc/chsrc.texi @@ -6,15 +6,15 @@ @c Contributors : Nul None @c | @c Created On : <2024-08-22> -@c Last Modified : <2024-10-09> +@c Last Modified : <2025-06-19> @c -------------------------------------------------------------- \input texinfo @setfilename chsrc.info @settitle chsrc -@set Chsrc_Version v0.1.9 -@set Doc_Publish_Date 2024-10-09 +@set Chsrc_Version v0.2.1.2 +@set Doc_Publish_Date 2025-06-19 @copying @comment 这是软件copyright，不是文档copyright，因此不放在titlepage