Update README

This commit is contained in:
Aoran Zeng 2024-08-19 14:30:04 +08:00
parent 4e09218b02
commit 229bb0a434
No known key found for this signature in database
GPG Key ID: 8F8BA8488E10ED98

View File

@ -2,7 +2,7 @@
<img alt="chsrc logo" src="image/chsrc.png"/>
</div>
全平台命令行换源工具,**目标支持 Linux (包括麒麟、openEuler、deepin 等), Windows, macOS, BSD 等尽可能多的操作系统龙芯、飞腾、RISC-V 等尽可能多的 CPU**。
全平台命令行换源工具,**目标支持 Linux, Windows, macOS, BSD 等尽可能多的操作系统龙芯、飞腾、RISC-V 等尽可能多的 CPU**。
我们使用 **C99** 来完成上述目标。我们并不使用 Python 或 JS 等解释语言,因为一个简单的换源工具,不应该强行塞给用户一个庞大的解释器和数十、数百 MB 其他文件。
@ -10,6 +10,33 @@
<br>
## 🤝 Contribute
> [!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)
- 案例: [Armbian](../src/recipe/os/APT/Armbian.c)
---
开发准则:
1. Convention over Configuration
2. [NO UFO 原则: 不要乱丢文件到$HOME等目录尤其是使用各种隐晦的文件名](https://www.yuque.com/ccmywish/blog/no-ufo)
---
> [!NOTE]
> 想通过 `flatpak`, `yay`,`pacman`,`apt`,`dnf` 等系统包管理工具来安装和更新`chsrc`?若您可提供维护,请访问 [issue#16 on GitHub](https://github.com/RubyMetric/chsrc/issues/16)
- [x] `homebrew`
- [x] `scoop`
- [ ] 缺乏 `AUR` 维护者
- [ ] 缺乏其他平台/包维护者
<br>
## 📌 示例
<div align="center">
@ -24,17 +51,7 @@
<img src="https://repology.org/badge/vertical-allrepos/chsrc.svg" alt="Packaging status" align="right">
</a>
> [!NOTE]
> 想通过 `yay`,`pacman`,`apt`,`dnf` 等系统包管理工具来安装和更新`chsrc`?若您可提供维护,请访问 [issue#16 on GitHub](https://github.com/RubyMetric/chsrc/issues/16)
- [x] `homebrew` 维护者
- [x] `scoop` 维护者
- [ ] 缺乏 `AUR` 维护者
- [ ] 缺乏其他平台/包维护者
---
> [!TIP]
> [!IMPORTANT]
> 若通过下述手动方式安装,则会下载到当前目录,可直接通过 `./chsrc` 运行
<details>