Skip to content

Commit a2851d5

Browse files
committed
Update doc
1 parent 54a93f9 commit a2851d5

File tree

4 files changed

+35
-13
lines changed

4 files changed

+35
-13
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
! -------------------------------------------------------------
44
! Doc Type : Markdown
55
! Doc Name : README.md
6-
! Doc Authors : Aoran Zeng <[email protected]>
7-
! Contributors : Nul None <[email protected]>
6+
! Doc Authors : Aoran Zeng <[email protected]>
7+
! Contributors : Mikachu2333 <[email protected]>
88
! |
99
! Created On : <2023-12-28>
10-
! Last Modified : <2025-06-18>
10+
! Last Modified : <2025-06-19>
1111
! ---------------------------------------------------------- -->
1212

1313
<div align="center">
@@ -39,13 +39,18 @@
3939

4040
> [!TIP]
4141
> **`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)
42+
4243
---
44+
4345
> [!NOTE]
44-
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助**。欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者参与贡献。[从开发到提交贡献,我们覆盖全流程文档](./doc/)
45-
,另外作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50)
46+
> 这是你可以参与的第一个现实世界中有用的C语言项目!不再是枯燥的数据结构习题,不用再面对二十年前古老界面的 **Dev-C++**[用 VS Code 一分钟内搭建环境编译、运行、测试、Debug chsrc !](./doc/01-Develop.md)
47+
>
48+
> 欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者。[从开发到提交PR,我们覆盖全流程文档](./doc/)
49+
,作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50)
4650
---
51+
4752
> [!IMPORTANT]
48-
> [招募 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130)
53+
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130)
4954
5055
<br>
5156

doc/01-Develop.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,28 @@
77
! Contributors : Nul None <[email protected]>
88
! |
99
! Created On : <2024-12-27>
10-
! Last Modified : <2025-03-06>
10+
! Last Modified : <2025-06-19>
1111
! ---------------------------------------------------------- -->
1212

1313
# 开发
1414

15-
## 环境
15+
## 开发环境
1616

17-
请安装好 `GCC``Clang``make` 以及 `curl`
17+
请安装好:
18+
19+
1. `GCC``Clang`
20+
2. [just]`make`
21+
3. `curl`
22+
23+
**我推荐你使用 VS Code 开发,你可以在一分钟内成功编译、运行和 Debug `chsrc`**
24+
25+
1. `Ctrl-Shift-B` 直接构建
26+
2. `F5` 直接开始 Debug
27+
28+
<br>
29+
30+
31+
## 准备
1832

1933
```bash
2034
# 请务必使用 dev 分支开发
@@ -25,6 +39,7 @@ $ git clone https://gitee.com/RubyMetric/chsrc.git -b dev
2539

2640
<br>
2741

42+
2843
## 编译运行
2944

3045
```bash
@@ -63,3 +78,5 @@ make clean
6378
关于分支的说明以及如何提交代码,请参考 [./03-CONTRIBUTING.md](./03-CONTRIBUTING.md)
6479

6580
<br>
81+
82+
[just]: https://github.com/casey/just

doc/chsrc.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
.\" Last Modified : <2025-06-16>
1010
.\" --------------------------------------------------------------
1111

12-
.TH chsrc 1 "2025-06-16" "v0.2.1.1" "RubyMetric chsrc"
12+
.TH chsrc 1 "2025-06-16" "v0.2.1.2" "RubyMetric chsrc"
1313

1414
.SH NAME
1515
chsrc - Change Source for every software on every platform from the command line

doc/chsrc.texi

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
@c Contributors : Nul None <[email protected]>
77
@c |
88
@c Created On : <2024-08-22>
9-
@c Last Modified : <2024-10-09>
9+
@c Last Modified : <2025-06-19>
1010
@c --------------------------------------------------------------
1111

1212
\input texinfo
1313
@setfilename chsrc.info
1414
@settitle chsrc
1515

16-
@set Chsrc_Version v0.1.9
17-
@set Doc_Publish_Date 2024-10-09
16+
@set Chsrc_Version v0.2.1.2
17+
@set Doc_Publish_Date 2025-06-19
1818

1919
@copying
2020
@comment 这是软件copyright,不是文档copyright,因此不放在titlepage

0 commit comments

Comments
 (0)