chsrc/README.md

<div align="center">
  <img alt="chsrc logo" src="chsrc.png"/>
</div>

全平台命令行换源工具，**目标支持 Linux, Windows, macOS, BSD 等所有操作系统，龙芯、申威、飞腾、兆芯、海光等所有CPU**。 若有不支持的情况，请提交issue。

我们使用 **C99** 来完成上述目标。另外，我们并不使用Python或JS等解释语言，因为一个简单的换源工具，不应该强行塞给用户一个庞大的解释器和数十、数百MB其他文件。

<br>

## 开发与维护

一个人无法精通各种软件，也没有机会使用多样的平台环境。因此我邀请您参与，维护你所熟悉的部分软件的换源。本软件为自由软件，**GPLv3** 许可证的采用将有机会使您的贡献被更广泛地使用，详情查阅 [LICENSE.txt](./LICENSE.txt)

参与维护开发，请查阅：[chsrc 协作者/维护者列表](https://gitee.com/RubyMetric/chsrc/issues/I7YI8E)

<br>

## 安装使用

目前还处于开发中，需要您手动编译来安装（仅有一个可执行文件）。后续将会通过持续构建生成二进制文件，欢迎您对此做出贡献，[查阅 issue](https://gitee.com/RubyMetric/chsrc/issues/I7ZBDR)

```bash
使用：chsrc <command> [target]

help                    # 打印此帮助，或 h, -h, --help
list (或 ls, 或 l)      # 查看可用镜像源，和可换源软件
list mirror(s)          # 查看可用镜像源
list target(s)          # 查看可换源软件
list <target>           # 查看该软件可以使用哪些源

cesu <target>           # 对该软件所有源测速
get  <target>           # 查看当前软件的源使用情况

set  <target>           # 换源，自动测速后挑选最快源
set  <target> def(ault) # 换源，默认使用维护团队测速第一的源
set  <target> <mirror>  # 换源，指定使用某镜像站
```

<br>

## 编程语言开发

```bash
chsrc set ruby   或 chsrc set gem
chsrc set python 或 chsrc set pip
chsrc set node   或 chsrc set npm  或 chsrc set nodejs
chsrc set perl   或 chsrc set cpan
chsrc set php    或 chsrc set composer

chsrc set go
chsrc set rust   或 chsrc set cargo  或 chsrc set crate
chsrc set java   或 chsrc set maven  或 chsrc set mvn  或 chsrc set gradle

# 同时会为 bioconductor 换源
chsrc set r      或 chsrc set cran
chsrc set julia
```

TODO: 上述已全部完成，但

1. 部分换源方案当前需要用户进行少量手动操作如 `java`，`rust`
2. 还未经多平台测试

<br>

## 操作系统

```bash
chsrc set ubuntu
chsrc set debian
chsrc set fedora
chsrc set arch
chsrc set manjaro
chsrc set kali
chsrc set gentoo

chsrc set openbsd
chsrc set netbsd

# 国产操作系统
chsrc set deepin
chsrc set openeuler
chsrc set openkylin

chsrc set msys2  或 chsrc set msys
```

TODO: 上述已全部完成，但

1. 部分换源方案当前需要用户进行少量手动操作如 `manjaro`
2. 还未经多平台测试

<br>

## 软件

TODO:
- [ ] `chsrc set brew`  或 `chsrc set homebrew`
- [ ] `chsrc set emacs`
- [ ] `chsrc set conda` 或 `chsrc set anaconda`
- [ ] `chsrc set ctan`  或 `chsrc set tex`

<br>

## 开发

请安装好 `gcc`或`clang` 和 `make` 以及 `curl`

```bash
make          # 默认使用 cc 编译
make CC=clang # 使用 clang 编译
make CC=gcc   # 使用 gcc   编译

make test  # 测试部分命令
make xy    # 测试 xy.h
make clean
```

<br>

## License

本软件采用 GPLv3 和 MIT 双许可证，具体请查阅 [LICENSE.txt](./LICENSE.txt)