From d642275209bacc39c4f2cf1ba3e6853760c890df Mon Sep 17 00:00:00 2001 From: Aoran Zeng Date: Thu, 12 Dec 2024 00:49:35 +0800 Subject: [PATCH] Update doc --- README.md | 19 ++++++++++++------- MAINTAINERS.md => doc/MAINTAINERS.md | 0 doc/Write-A-Recipe-Even-If-You-Dont-Know-C.md | 5 ++++- 3 files changed, 16 insertions(+), 8 deletions(-) rename MAINTAINERS.md => doc/MAINTAINERS.md (100%) diff --git a/README.md b/README.md index 21209269..d6619041 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,19 @@ ## 🤝 协作与贡献 +> [!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)。 -> -> [积极招募 Recipe Maintainers 维护者!](https://github.com/RubyMetric/chsrc/issues/130) -> [!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) +> [!IMPORTANT] +> [招募 Recipe 负责人与维护者!](https://github.com/RubyMetric/chsrc/issues/130)
@@ -307,10 +311,11 @@ reset # 重置,使用上游默认使用的源 ```bash chsrc set ruby|rb|gem|bundler|rubygems -chsrc set python | py | pypi # 同时换 pip, poetry 和 pdm 这3个包管理器,也可以3个独立换源 +chsrc set python | py | pypi # 同时换 pip, poetry, pdm, uv 这4个包管理器,也可以4个独立换源 chsrc set pip chsrc set poetry chsrc set pdm + chsrc set uv chsrc set rye diff --git a/MAINTAINERS.md b/doc/MAINTAINERS.md similarity index 100% rename from MAINTAINERS.md rename to doc/MAINTAINERS.md diff --git a/doc/Write-A-Recipe-Even-If-You-Dont-Know-C.md b/doc/Write-A-Recipe-Even-If-You-Dont-Know-C.md index c5118859..cc228956 100644 --- a/doc/Write-A-Recipe-Even-If-You-Dont-Know-C.md +++ b/doc/Write-A-Recipe-Even-If-You-Dont-Know-C.md @@ -32,7 +32,10 @@
-成功案例: [Armbian](../src/recipe/os/APT/Armbian.c) +成功案例: + +1. [Armbian](../src/recipe/os/APT/Armbian.c) +2. [uv](../src/recipe/lang/Python/uv.c)