Skip to content

Commit 4a89c96

Browse files
committed
Update doc
1 parent d498488 commit 4a89c96

File tree

3 files changed

+25
-22
lines changed

3 files changed

+25
-22
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ test-fw:
4444
@$(CC) test/fw.c $(CFLAGS) -o fw
4545
@./fw
4646

47+
# AUR package 安装时将执行此 target
4748
fastcheck: $(Target)
4849
@perl ./test/cli.pl fastcheck
4950

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,11 @@
2828
> [!TIP]
2929
> **`chsrc` 不仅是一个命令行工具,同时也是一个换源框架,它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。** 给新软件添加换源方法总共分几步?[Write A Recipe Even If You Don't Know C](./doc/Write-A-Recipe-Even-If-You-Dont-Know-C.md)
3030
31-
1. 复制 [recipe 模版](./src/recipe/recipe-template.c) 并替换占位符
32-
2.[Wiki](https://github.com/RubyMetric/chsrc/wiki) 中找可用源
33-
3. 添加具体的换源步骤
34-
4. 编译运行!`chsrc set my-favorite-software`
35-
3631
> [!NOTE]
3732
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助**。欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者参与贡献,作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50)
3833
3934
> [!IMPORTANT]
40-
> [招募 Recipe 负责人与维护者!](https://github.com/RubyMetric/chsrc/issues/130)
35+
> [招募 Recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130)
4136
4237
<br>
4338

@@ -76,6 +71,7 @@
7671
- [x] `Homebrew`
7772
- [x] `Scoop`
7873
- [x] `AUR`
74+
- [x] `WinGet`
7975
- [ ] `Flatpak`
8076
- [ ] `snap`
8177
- [ ] 缺乏其他平台/包维护者
@@ -408,19 +404,25 @@ chsrc set conda | anaconda
408404

409405
## 🛠️ 开发
410406

411-
请安装好 `gcc``clang``make` 以及 `curl`
407+
请安装好 `GCC``Clang``make` 以及 `curl`
412408

413-
```bash
414-
# 使用 dev 分支开发
415-
git clone https://gitee.com/RubyMetric/chsrc.git -b dev
409+
关于分支的说明以及如何提交代码,请参考 [doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md)
416410

417-
make # 默认使用 cc 编译
418-
make CC=clang # 使用 clang 编译
419-
make CC=gcc # 使用 gcc 编译
411+
```bash
412+
# 请务必使用 dev 分支开发
413+
$ git clone https://gitee.com/RubyMetric/chsrc.git -b dev
414+
```
420415

421-
make test # 测试命令
422-
make test-xy # 测试 xy.h
423-
make clean
416+
```bash
417+
$ make # 默认使用 cc 编译
418+
$ make CC=clang # 使用 clang 编译
419+
$ make CC=gcc # 使用 gcc 编译
420+
421+
$ make test-xy # 测试 xy.h
422+
$ make test-fw # 测试 framework
423+
$ make test # 测试上述两个
424+
$ make test-cli # 测试命令
425+
$ make clean
424426
```
425427

426428
<br>

doc/Write-A-Recipe-Even-If-You-Dont-Know-C.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
! Contributors : Nul None <[email protected]>
77
! |
88
! Created On : <2024-08-19>
9-
! Last Modified : <2024-11-23>
9+
! Last Modified : <2024-12-23>
1010
! ---------------------------------------------------------- -->
1111

1212
# Write A Recipe Even If You Don't Know C
@@ -19,12 +19,12 @@
1919

2020
我鼓励你为新的软件添加换源支持,因为通过 `chsrc` 这将非常简单,你的贡献也将非常有价值。理论上每一个 `recipe` 都需要有专人长时间维护。
2121

22-
1. 本项目采用`GPLv3+`协议,是真正的**自由软件**,而非仅仅是开源软件
23-
2. 代码规范灵活遵循`GNU`标准(若标准干扰了可维护性,则并不采纳)
22+
1. 本项目采用 `GPLv3+` 协议,是真正的**自由软件**,而非仅仅是开源软件
23+
2. 代码规范灵活遵循 `GNU` 标准(若标准干扰了可维护性,则并不采纳)
2424
3. 高度模块化,目录结构清晰易懂
25-
4. 极易构建,仅有一个C语言编译器即可
26-
5. 易于将`shell`脚本转换为等价的`recipe`
27-
6. 已有大量`recipe`可提供参考,并提供了 [recipe template] 供直接使用
25+
4. 极小依赖,极易构建,只需要 `GCC``Clang` 即可编译
26+
5. 易于将 `shell` 脚本转换为等价的 `recipe`
27+
6. 已有大量 `recipe` 可提供参考,并提供了 [recipe template] 供直接使用
2828
7. 提供持续关注镜像站可用性的协作平台:
2929

3030
1. https://github.com/RubyMetric/chsrc/wiki

0 commit comments

Comments
 (0)