From 7f0888c9da652dd6ecae8e491b75bfef1d30b381 Mon Sep 17 00:00:00 2001 From: Mikachu2333 Date: Tue, 17 Jun 2025 00:31:43 +0800 Subject: [PATCH] format --- doc/01-Develop.md | 16 +++--- ...-Write-A-Recipe-Even-If-You-Dont-Know-C.md | 12 ++--- doc/04-MAINTAINERS.md | 52 +++++++++++++++++-- 3 files changed, 61 insertions(+), 19 deletions(-) diff --git a/doc/01-Develop.md b/doc/01-Develop.md index 403a16b..27f4cf7 100644 --- a/doc/01-Develop.md +++ b/doc/01-Develop.md @@ -28,9 +28,9 @@ $ git clone https://gitee.com/RubyMetric/chsrc.git -b dev ## 编译运行 ```bash -$ make # 默认使用 cc 编译 -$ make CC=clang # 使用 clang 编译 -$ make CC=gcc # 使用 gcc 编译 +make # 默认使用 cc 编译 +make CC=clang # 使用 clang 编译 +make CC=gcc # 使用 gcc 编译 ``` ```bash @@ -49,11 +49,11 @@ $ make DEBUG=1 ## 测试 ```bash -$ make test-xy # 测试 xy.h -$ make test-fw # 测试 framework -$ make test # 测试上述两个 -$ make test-cli # 测试命令 -$ make clean +make test-xy # 测试 xy.h +make test-fw # 测试 framework +make test # 测试上述两个 +make test-cli # 测试命令 +make clean ```
diff --git a/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md b/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md index 67dc2a8..1be7f41 100644 --- a/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md +++ b/doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md @@ -12,7 +12,7 @@ # Write A Recipe Even If You Don't Know C -# 介绍 +## 介绍 **`chsrc` 不仅是一个命令行工具,同时也是一个体现了 Ruby on Rails 思想的 MVC 换源框架,它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。** @@ -28,8 +28,8 @@ 6. 已有大量 `recipe` 可提供参考,并提供了 [recipe template] 供直接使用 7. 提供持续关注镜像站可用性的协作平台: - 1. https://github.com/RubyMetric/chsrc/wiki - 2. https://github.com/RubyMetric/chsrc/discussions + 1. + 2.
@@ -40,7 +40,7 @@
-# 基本概念 +## 基本概念 1. `target`: 所要换源的目标 @@ -59,7 +59,7 @@
-# 编写 `recipe` 步骤 +## 编写 `recipe` 步骤 1. 确定你要编写的 `target` 的标准名称,创建 `Target-Name.c` 文件 @@ -90,7 +90,7 @@
-# 开发准则 +## 开发准则 1. 代码高度可移植 diff --git a/doc/04-MAINTAINERS.md b/doc/04-MAINTAINERS.md index 29a85fa..c7d2a6f 100644 --- a/doc/04-MAINTAINERS.md +++ b/doc/04-MAINTAINERS.md @@ -10,12 +10,10 @@ **目前项目的发展阶段还处于 *外行实现内行* 的情况,比如 Homebrew recipe,实现者根本不是 Homebrew 的真实用户,只是根据各种文档来实现,然后等待用户反馈。所以这里当前的实现者最多只能是 Maintainer,无法承担 Director 的责任** - 2. **Maintainers** 维护者:实现和持续维护 recipe,需要和 Director 一起 review 代码。可参考 [03-CONTRIBUTING.md](./03-CONTRIBUTING.md) 了解项目是如何进行提交和审阅代码的 - 3. **Observers** 观察者:对该 target 和 recipe 持续反馈和关注的用户。如果你觉得你无法承担作为维护者的责任,可以退而求其次作为观察者积极参与其中 @@ -28,7 +26,6 @@
- ## Framework 1. **Director**: `@ccmywish` `@gitee:G_I_Y` @@ -37,80 +34,94 @@
- ## 编程语言 ### Ruby + 1. **Director**: `@ccmywish` 2. **Maintainers**: 3. **Observers**: ### Python + 1. **Director**: 2. **Maintainers**: `@ccmywish` `@happy-game` 3. **Observers**: ### NodeJS + 1. **Director**: 2. **Maintainers**: `@ccmywish` `@happy-game` 3. **Observers**: ### Perl + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### PHP + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Go + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Rust + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Java + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Clojure + 1. **Director**: 2. **Maintainers**: 3. **Observers**: ### NuGet + 1. **Director**: 2. **Maintainers**: 3. **Observers**: ### Dart + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Haskell + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### OCaml + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### R + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: `@gitee:tfcolin` ### Julia + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: @@ -120,166 +131,197 @@ ## 操作系统 ### Ubuntu + 1. **Director**: `@ccmywish` 2. **Maintainers**: `@gitee:G_I_Y` 3. **Observers**: `@wickdynex` ### Debian + 1. **Director**: 2. **Maintainers**: `@ccmywish` `@gitee:G_I_Y` 3. **Observers**: `@happy-game` ### Fedora + 1. **Director**: 2. **Maintainers**: `@ccmywish` `@gitee:G_I_Y` `@happy-game` 3. **Observers**: ### Kali + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` 3. **Observers**: ### Linux Mint + 1. **Director**: 2. **Maintainers**: `@ccmywish` `@gitee:G_I_Y` 3. **Observers**: ### Armbian + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Raspberry Pi OS + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### ROS + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` `@ccmywish` 3. **Observers**: ### Trisquel + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Arch + 1. **Director**: 2. **Maintainers**: `@ccmywish` `@gitee:G_I_Y` `@happy-game` 3. **Observers**: ### Manjaro + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` `@ccmywish` 3. **Observers**: ### msys2 + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` `@ccmywish` 3. **Observers**: ### Alpine + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### OpenWrt + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: `@happy-game` ### Gentoo + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` 3. **Observers**: ### Void Linux + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### deepin + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` 3. **Observers**: ### OpenKylin + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` 3. **Observers**: ### OpenEuler + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` 3. **Observers**: ### FreeBSD + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` `@ccmywish` 3. **Observers**: `@ykla` ### NetBSD + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` `@ccmywish` 3. **Observers**: ### OpenBSD + 1. **Director**: 2. **Maintainers**: `@gitee:G_I_Y` `@ccmywish` 3. **Observers**: -
## 软件 ### Homebrew + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: `@wickdynex` ### WinGet + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Flathub + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Nix + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Guix + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### CocoaPods + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Docker Hub + 1. **Director**: 2. **Maintainers**: `@ccmywish` `@happy-game` 3. **Observers**: ### Anaconda + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: `@happy-game` ### Emacs + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: ### Tex Live + 1. **Director**: 2. **Maintainers**: `@ccmywish` 3. **Observers**: