Update doc
Some checks failed
Publish AUR Package (chsrc-git) / publish (push) Has been cancelled

This commit is contained in:
Aoran Zeng 2024-12-23 10:29:47 +08:00
parent d49848842c
commit 4a89c96232
No known key found for this signature in database
GPG Key ID: 8F8BA8488E10ED98
3 changed files with 24 additions and 21 deletions

View File

@ -44,6 +44,7 @@ test-fw:
@$(CC) test/fw.c $(CFLAGS) -o fw
@./fw
# AUR package 安装时将执行此 target
fastcheck: $(Target)
@perl ./test/cli.pl fastcheck

View File

@ -28,16 +28,11 @@
> [!TIP]
> **`chsrc` 不仅是一个命令行工具同时也是一个换源框架它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。** 给新软件添加换源方法总共分几步?[Write A Recipe Even If You Don't Know C](./doc/Write-A-Recipe-Even-If-You-Dont-Know-C.md)
1. 复制 [recipe 模版](./src/recipe/recipe-template.c) 并替换占位符
2. 在 [Wiki](https://github.com/RubyMetric/chsrc/wiki) 中找可用源
3. 添加具体的换源步骤
4. 编译运行!`chsrc set my-favorite-software`
> [!NOTE]
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助**。欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者参与贡献,作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50)。
> [!IMPORTANT]
> [招募 Recipe 负责人与维护者!](https://github.com/RubyMetric/chsrc/issues/130)
> [招募 Recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130)
<br>
@ -76,6 +71,7 @@
- [x] `Homebrew`
- [x] `Scoop`
- [x] `AUR`
- [x] `WinGet`
- [ ] `Flatpak`
- [ ] `snap`
- [ ] 缺乏其他平台/包维护者
@ -408,19 +404,25 @@ chsrc set conda | anaconda
## 🛠️ 开发
请安装好 `gcc`或`clang` 和 `make` 以及 `curl`
请安装好 `GCC``Clang``make` 以及 `curl`
关于分支的说明以及如何提交代码,请参考 [doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md)
```bash
# 使用 dev 分支开发
git clone https://gitee.com/RubyMetric/chsrc.git -b dev
# 请务必使用 dev 分支开发
$ git clone https://gitee.com/RubyMetric/chsrc.git -b dev
```
make # 默认使用 cc 编译
make CC=clang # 使用 clang 编译
make CC=gcc # 使用 gcc 编译
```bash
$ make # 默认使用 cc 编译
$ make CC=clang # 使用 clang 编译
$ make CC=gcc # 使用 gcc 编译
make test # 测试命令
make test-xy # 测试 xy.h
make clean
$ make test-xy # 测试 xy.h
$ make test-fw # 测试 framework
$ make test # 测试上述两个
$ make test-cli # 测试命令
$ make clean
```
<br>

View File

@ -6,7 +6,7 @@
! Contributors : Nul None <nul@none.org>
! |
! Created On : <2024-08-19>
! Last Modified : <2024-11-23>
! Last Modified : <2024-12-23>
! ---------------------------------------------------------- -->
# Write A Recipe Even If You Don't Know C
@ -19,12 +19,12 @@
我鼓励你为新的软件添加换源支持,因为通过 `chsrc` 这将非常简单,你的贡献也将非常有价值。理论上每一个 `recipe` 都需要有专人长时间维护。
1. 本项目采用`GPLv3+`协议,是真正的**自由软件**,而非仅仅是开源软件
2. 代码规范灵活遵循`GNU`标准(若标准干扰了可维护性,则并不采纳)
1. 本项目采用 `GPLv3+` 协议,是真正的**自由软件**,而非仅仅是开源软件
2. 代码规范灵活遵循 `GNU` 标准(若标准干扰了可维护性,则并不采纳)
3. 高度模块化,目录结构清晰易懂
4. 极易构建仅有一个C语言编译器即可
5. 易于将`shell`脚本转换为等价的`recipe`
6. 已有大量`recipe`可提供参考,并提供了 [recipe template] 供直接使用
4. 极小依赖,极易构建,只需要 `GCC``Clang` 即可编译
5. 易于将 `shell` 脚本转换为等价的 `recipe`
6. 已有大量 `recipe` 可提供参考,并提供了 [recipe template] 供直接使用
7. 提供持续关注镜像站可用性的协作平台:
1. https://github.com/RubyMetric/chsrc/wiki