Add README files for the project

1 files changed, 48 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!