diff options
| -rw-r--r-- | README.txt | 48 | ||||
| -rw-r--r-- | README_zh_CN.txt | 41 |
2 files changed, 89 insertions, 0 deletions
diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..ab67501 --- /dev/null +++ b/README.txt @@ -0,0 +1,48 @@ + Butchunker + "Open-source file chunking framework" + +I. Introduction + + Butchunker is an extensible file chunking framework that allows files to be split + using specialized schemes to specifically improve deduplication rates. + +Please note: + 1. It only splits files and [currently] does not compress them. + 2. Providing specialized splitting schemes for different formats can significantly + improve file deduplication rates, but it still cannot handle files that are + inherently highly variable. + 3. The execution of specialized schemes only occurs during the write phase; + the rebuild phase simply restores known chunks in order. + +II. Installation + + Currently, only source builds are provided. This is partly because it is in the + development stage, and partly because it is typically used by being linked into + other projects. + +Source Build: + 1. Clone the source code from any Git repository hosting Butchunker. + 2. Execute locally (please ensure you have the Rust toolchain installed): + + cargo install --path ./ + + 3. After installation, you should be able to use the binary programs + `butck` and `butckrepo-refresh`. + 4. Clone the policy repository to ./policy/ + 5. Execute `butckrepo-refresh` to refresh the policy registry. + 6. Execute step 2 again to reinstall. + 7. Execute the following command locally to check if your policies have been compiled: + + butck lspolicy-all + +III. Support + + If you encounter any issues during use or installation, or are interested + in the project, + + please contact Weicao-CatilGrass directly. I'm happy to chat! + +IV. License + + The project uses the MIT and APACHE-2.0 licenses and promises not to change them. + Feel free to link the code into any project for use! diff --git a/README_zh_CN.txt b/README_zh_CN.txt new file mode 100644 index 0000000..74c3e28 --- /dev/null +++ b/README_zh_CN.txt @@ -0,0 +1,41 @@ + Butchunker + "Open-source file chunking framework" + +I. 简介 + + Butchunker 是一款可扩展的文件分块框架，允许文件以特化的方案进行拆分，以针对性地提高去重率 + +不过要注意： + 1. 它只拆分文件，[暂] 不压缩文件 + 2. 为不同格式提供特化的拆分方案可让文件的去重率显著提高， + 但对于本身变化就很大的文件，它仍然无法胜任 + 3. 特化方案的执行只发生在写入阶段，重建阶段只是将已知块按顺序还原 + +II. 安装 + + 目前只提供源码构建，一方面是因为 正在开发阶段， + 另一方面是因为 它一般用于链接至其他项目中使用 + +源码构建： + 1. 从任意存储 Butchunker 的 Git 仓库克隆源代码 + 2. 在本地执行 （请确保您安装了 Rust 工具链） + + cargo install --path ./Cargo.lock + + 3. 安装后，您应当可以使用二进制程序 `butck` 和 `butckrepo-refresh` + 4. 将策略仓库克隆到 ./policy/ + 5. 执行 `butckrepo-refresh` 刷新策略注册表 + 6. 再次执行第二步，重新安装 + 7. 在本地执行如下命令，以检测您的策略是否已经被编译 + + butck lspolicy-all + +III. 支持 + + 如果在使用和安装过程中有任何问题，或者对该项目感兴趣， + 请直接联系 Weicao-CatilGrass，我很乐意交流 + +IV. 许可证 + + 项目使用 MIT 和 APACHE-2.0 许可证，且承诺不会变更 + 可以放心将代码链接到任何项目中使用！ |