Skip to content

Latest commit

 

History

History
102 lines (62 loc) · 3.8 KB

Write-A-Recipe-Even-If-You-Dont-Know-C.md

File metadata and controls

102 lines (62 loc) · 3.8 KB
Raw

Write A Recipe Even If You Don't Know C

介绍

chsrc 不仅是一个命令行工具，同时也是一个换源框架，它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。


我鼓励你为新的软件添加换源支持，因为通过 chsrc 这将非常简单，你的贡献也将非常有价值。理论上每一个 recipe 都需要有专人长时间维护。

  1. 本项目采用 GPLv3+ 协议，是真正的自由软件，而非仅仅是开源软件

  2. 代码规范灵活遵循 GNU 标准（若标准干扰了可维护性，则并不采纳）

  3. 高度模块化，目录结构清晰易懂

  4. 极小依赖，极易构建，只需要 GCC 或 Clang 即可编译

  5. 易于将 shell 脚本转换为等价的 recipe

  6. 已有大量 recipe 可提供参考，并提供了 recipe template 供直接使用

  7. 提供持续关注镜像站可用性的协作平台:

    1. https://github.com/RubyMetric/chsrc/wiki
    2. https://github.com/RubyMetric/chsrc/discussions

成功案例:

  1. Armbian
  2. uv

贡献指导

若有任何问题，可在 GitHub discussions 中询问和讨论


基本概念

  1. target: 所要换源的目标

  2. category: 是 target category 的简写，即 target 所属的类别，可以是 编程语言，操作系统，软件 三类之一

    1. 在目录中，三者分别为 lang, os, ware
    2. 在代码中，三者前缀分别为 pl, os, wr

  3. mirror: 是 mirror site 的简写，指镜像站，如清华大学开源软件镜像站

  4. source: 该 target 所能换的具体的源，由 mirror 提供服务，往往一个 mirror 会提供许多 source

  5. recipe: 是为一个 target 定义的具体换源方法，请参考 src 目录中的 recipe 目录

  6. feature: 一个 target 可以支持的功能，比如能否重置回上游默认源等

  7. 镜像源: 为了方便，偶尔我们将直接称mirror和/或source为镜像源，这只是一种方便性的称呼，可以统称二者，也可以根据上下文指代二者之一


编写recipe步骤

  1. 务必使用 dev 分支

  2. 在 recipe 目录中根据类别添加新文件，该文件可基于其它 recipe 或 recipe template

  3. 最好的参照物是 ruby.c recipe

  4. 在各大镜像站寻找可用源；可以额外补充镜像站

    并创建或更新对应 target 的镜像站可用状态Wiki页: https://github.com/RubyMetric/chsrc/wiki

  5. 可以使用这些函数:

    1. framework/core.c 中以 chsrc_ 开头的所有函数或宏
    2. xy.h 中以 xy_ 开头的所有函数或宏

  6. 在 recipe/menu.c 中添加用户可以使用的 target 别名

  7. 构建并运行 chsrc set <target> 测试，若无问题可提交 Pull Request


开发准则

  1. 代码高度可移植

  2. Convention over Configuration

  3. NO UFO 原则: 不要乱丢文件到$HOME等目录，尤其是使用各种隐晦的文件名

    chsrc 主程序不提供配置文件，不提供数据文件，干净无污染。那么在实现 recipe 的时候，除了备份文件外，也不要污染用户环境。