Ricer

帮助用户管理他们的 rice 配置。

Ricer 是一个实验性的命令行工具，旨在通过 Git 管理和组织 [rice][explain-rice] 配置。Ricer 允许用户将他们的家目录视为一个常规的 Git 目录。用户拥有的每个配置都将放入他们自己的“假裸”仓库中。“假裸”仓库系统允许用户模块化他们的配置，以便更容易地在多台机器上部署。

如果 Ricer 的行为看起来很熟悉，那是因为 Ricer 从 vcsh 中借鉴了许多概念。事实上，可以认为 Ricer 是 vcsh 的 Rust 版本。尽管 Ricer 试图在 Rust 中将 vcsh 和 mr 结合到一个简洁的程序中。

安装

您需要以下软件

1. Git [>= 2.25.0]。
2. Rust [>= 1.74.1]。

克隆此仓库并使用 Cargo 如下

# git clone https://github.com/rice-configs/ricer.git
# cd ricer
# cargo build --release
# cargo install

确保您的 $PATH 包含 $HOME/.cargo/bin 以执行 Ricer 二进制文件。

享受吧！

用法

通过 Ricer 创建一个新的 Vim 配置仓库

# ricer init vim

将 .vimrc 添加到新的 Vim 仓库中

# ricer vim add ~/.vimrc

提交新添加的文件

# ricer vim commit -m 'Initial commit of my Vim config'

添加 Vim 配置的远程仓库

# ricer vim remote add origin https://url/to/remote/vim.git

将更改推送到远程仓库

# ricer vim push -u origin main

现在这个 Vim 配置可以被克隆到新的机器上

# ricer clone https://url/to/remote/vim.git vim

由于 git2-rs 库的限制，Ricer 不提供完整的 Git 命令集。因此，如果您需要像稀疏检出、子模块等更高级的功能，则 Ricer 可以直接将您放入目标仓库，以运行 Git 二进制文件，如下所示

# ricer enter vim

或者您也可以使用以下快捷方式

# ricer vim

有关使用 Ricer 的更多详细信息，请参阅项目提供的手册页。

致谢

Richard Hartmann的vcsh启发Ricer的创造，为Ricer的命令集和功能提供了一个基本框架。

为将Git集成到Ricer中提供更地道方式的git2-rs库。最初，Ricer只是打算用std::process::Command包裹Git。

贡献

Ricer编码项目接受以下形式的贡献

1. 对生产代码的改进或添加。
2. 对测试代码的改进或添加。
3. 对构建系统的改进或添加。
4. 对文档的改进或添加。
5. 对CI/CD管道的改进或添加。

有关向Ricer项目贡献的更多信息，请参阅贡献指南。

版权和许可

由于各种原因，Ricer编码项目使用了几个不同的许可协议来涵盖代码库的不同部分。然而，Ricer应被视为使用GNU GPL版本2许可协议（附带一些扩展）的自由软件。

该项目使用REUSE版本3规范，以便更容易确定代码库中任何给定文件的版权和许可，带有SPDX标识符。Ricer还采用了开发者原创性证书版本1.1，以确保任何贡献都有权合并到项目中，并且可以按照主要许可证与项目一起分发。

主要许可证

版权（C）2024 Jason Pena <[email protected]>

Ricer程序是自由软件；您可以在自由软件基金会发布的GNU通用公共许可证条款下重新分发和/或修改它；许可证的第2版，或者（根据您的选择）任何更高版本。

此程序还使用GPL合作承诺版本1.0，以赋予自己GNU GPL版本3提供的治愈和恢复条款，以避免因任何报告的违规行为而立即终止其GPL许可证。

分发此程序时，希望它是有用的，但没有任何保证；甚至没有关于其适销性或对特定目的适用性的暗示保证。有关详细信息，请参阅GNU通用公共许可证。

您应该已经收到GNU通用公共许可证和合作承诺的副本；如果没有，请写信给自由软件基金会，公司地址：51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA。

文档许可证

Ricer编码项目使用Creative Commons署名-相同方式4.0国际许可证来涵盖其公共文档文件。希望这个许可证将使在互联网上分发Ricer的文档变得更加容易。

公有领域许可证

代码库的一些部分要么太小，要么太通用，无法声称拥有版权。因此，这些部分将通过Creative Commons CC0 1.0 Unversial许可证进入公有领域。选择这个许可证是为了那些在法律上没有公有领域概念的国家。