mirror of
https://github.com/RubyMetric/chsrc.git
synced 2025-02-02 14:41:18 +08:00
Update doc
This commit is contained in:
parent
10d376885c
commit
bc17cf3620
10
README.md
10
README.md
|
@ -10,7 +10,7 @@
|
|||
|
||||
<br>
|
||||
|
||||
## 🤝 Contribute
|
||||
## 🤝 贡献
|
||||
|
||||
> [!TIP]
|
||||
> **`chsrc` 不仅是一个命令行工具,同时也是一个换源框架,它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。**
|
||||
|
@ -20,13 +20,7 @@
|
|||
- 案例:[Armbian](./src/recipe/os/APT/Armbian.c)
|
||||
- 挑战:[CentOS (Stream) Recipe Challenge!](https://github.com/RubyMetric/chsrc/issues/48)
|
||||
|
||||
---
|
||||
|
||||
开发准则:
|
||||
1. Convention over Configuration
|
||||
2. [NO UFO 原则: 不要乱丢文件到$HOME等目录,尤其是使用各种隐晦的文件名](https://www.yuque.com/ccmywish/blog/no-ufo)
|
||||
|
||||
---
|
||||
<br>
|
||||
|
||||
> [!NOTE]
|
||||
> 想通过 `flatpak`, `yay`,`pacman`,`apt`,`dnf` 等系统包管理工具来安装和更新`chsrc`?若您可提供维护,请访问 [issue#16 on GitHub](https://github.com/RubyMetric/chsrc/issues/16)
|
||||
|
|
|
@ -28,6 +28,12 @@
|
|||
|
||||
<br>
|
||||
|
||||
# 贡献指导
|
||||
|
||||
若有任何问题,可在 [GitHub discussions](https://github.com/RubyMetric/chsrc/discussions) 中询问和讨论
|
||||
|
||||
<br>
|
||||
|
||||
# 基本概念
|
||||
|
||||
1. `target`: 所要换源的目标
|
||||
|
@ -61,7 +67,16 @@
|
|||
|
||||
7. 构建并运行 `chsrc set <target>` 测试,若无问题可提交 Pull Request
|
||||
|
||||
<br>
|
||||
|
||||
若有任何问题,可在 [GitHub discussions](https://github.com/RubyMetric/chsrc/discussions) 中询问和讨论
|
||||
# 不要制造UFO
|
||||
|
||||
开发准则:
|
||||
1. Convention over Configuration
|
||||
2. [NO UFO 原则: 不要乱丢文件到$HOME等目录,尤其是使用各种隐晦的文件名](https://www.yuque.com/ccmywish/blog/no-ufo)
|
||||
|
||||
`chsrc` 主程序不提供配置文件,不提供数据文件,干净无污染。那么在实现 `recipe` 的时候,除了备份文件外,也不要污染用户环境。
|
||||
|
||||
<br>
|
||||
|
||||
[recipe template]: ../src/recipe/template.c
|
||||
|
|
Loading…
Reference in New Issue
Block a user