Skip to content

Commit b9e7937

Browse files
committed
Update doc
1 parent 31852b4 commit b9e7937

File tree

3 files changed

+56
-11
lines changed

3 files changed

+56
-11
lines changed

.vscode/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
! SPDX-License-Identifier: GFDL-1.3-or-later
33
! -------------------------------------------------------------
44
! Doc Type : Markdown
5-
! Doc Name : (for VS Code Devers) README.md
5+
! Doc Name : (for VS Code users) README.md
66
! Doc Authors : Aoran Zeng <[email protected]>
77
! Contributors : Nul None <[email protected]>
88
! |
99
! Created On : <2025-06-18>
10-
! Last Modified : <2025-06-19>
10+
! Last Modified : <2025-06-20>
1111
! ---------------------------------------------------------- -->
1212

1313
# Dev in VS Code

README.md

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

1313
<div align="center">
@@ -43,14 +43,14 @@
4343
---
4444

4545
> [!NOTE]
46-
> 这是你可以参与的第一个现实世界中有用的C语言项目!不再是枯燥的数据结构习题,不用再面对二十年前古老界面的 **Dev-C++**[用 VS Code 一分钟内搭建环境编译、运行、测试、Debug chsrc !](./doc/01-Develop.md)
46+
> 这是你可以参与的第一个现实世界中有用的C语言项目[用 VS Code 一分钟内上手编译、运行、测试 chsrc ](./doc/01-Develop.md)
4747
>
4848
> 欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者。[从开发到提交PR,我们覆盖全流程文档](./doc/)
4949
,作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50)
5050
---
5151

5252
> [!IMPORTANT]
53-
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130)
53+
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130)
5454
5555
<br>
5656

doc/01-Develop.md

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

13-
# 开发
13+
# 开发 chsrc
1414

15-
## 开发环境
15+
## 依赖与开发环境
1616

1717
请安装好:
1818

@@ -28,7 +28,8 @@
2828
<br>
2929

3030

31-
## 准备
31+
32+
## 获取代码
3233

3334
```bash
3435
# 请务必使用 dev 分支开发
@@ -40,7 +41,10 @@ $ git clone https://gitee.com/RubyMetric/chsrc.git -b dev
4041
<br>
4142

4243

43-
## 编译运行
44+
45+
## `make` 用户
46+
47+
### 编译运行
4448

4549
```bash
4650
make # 默认使用 cc 编译
@@ -61,7 +65,7 @@ $ make DEBUG=1
6165

6266
<br>
6367

64-
## 测试
68+
### 测试
6569

6670
```bash
6771
make test-xy # 测试 xy.h
@@ -73,6 +77,47 @@ make clean
7377

7478
<br>
7579

80+
81+
82+
## `just` 用户
83+
84+
如果你使用 `just`,可以在 VS Code 中获得更好的体验
85+
86+
### 编译运行
87+
88+
```bash
89+
just # 在Windows上默认使用 gcc 编译,在Linux上默认使用cc编译
90+
just CC=clang # 使用 clang 编译
91+
just CC=gcc # 使用 gcc 编译
92+
```
93+
94+
```bash
95+
# 启动 GDB 调试
96+
$ just debug
97+
98+
# 使用 LLDB 调试
99+
$ just DEBUGGER=lldb debug
100+
101+
# 如果需要单独生成含有编译信息的二进制文件(这个不会自己启动debugger)
102+
$ just DEBUG=1
103+
```
104+
105+
<br>
106+
107+
### 测试
108+
109+
```bash
110+
just test-xy # 测试 xy.h
111+
just test-fw # 测试 framework
112+
just test # 测试上述两个
113+
just test-cli # 测试命令
114+
just clean
115+
```
116+
117+
<br>
118+
119+
120+
76121
## 提交 PR
77122

78123
关于分支的说明以及如何提交代码,请参考 [./03-CONTRIBUTING.md](./03-CONTRIBUTING.md)

0 commit comments

Comments
 (0)