From fa3f5466208032847b1183691c97b4630fb3a284 Mon Sep 17 00:00:00 2001
From: duyiwei <duyiwei@kylinos.cn>
Date: Wed, 21 Jun 2023 05:50:23 +0000
Subject: [PATCH] Specification NestOS Project Component Description File

Signed-off-by: duyiwei <duyiwei@kylinos.cn>
---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 38 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 2c56ce0..fc96beb 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,54 @@
 # zchunk
 
 #### 介绍
-zchunk is a compressed file format that splits the file into independent chunks.
+zchunk 是一种压缩文件格式，专为高效增量而设计，同时保持良好的压缩性能，可将文件拆分为独立的块。 这允许在下载文件的新版本时仅下载更改的块。zchunk 文件受到强校验和的保护，以验证下载的文件实际上是想要的文件。
+zchunk is a compressed file format that splits the file into independent chunks. This allows you to only download changed chunks when downloading a new version of the file. Files can hosted on any web server that supports HTTP ranged requests, with no special software required to serve the files (though to download only the changed chunks, your client must be zchunk-aware).
 
-#### 软件架构
-软件架构说明
+#### 安装教程
 
+Install zchunk rpm package:
+
+yum install zchunk
 
-#### 安装教程
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+要从源码构建和安装 zchunk，首先安装 meson 并运行
+meson build
+cd build
+ninja
+ninja test
+sudo ninja install
+
+ 
+如果正在构建一些库存储在 /usr/local 中的操作系统，则需要替换上面的 meson build，如下所示：
+CFLAGS=-I/usr/local/include CXXFLAGS=-I/usr/local/include LDFLAGS=-L/usr/local/lib meson build
+
 
 #### 使用说明
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+To decompress a zchunk file, simply run:
+
+   unzck <filename>
+
+To compress a new zchunk file, run:
+
+    zck <filename>
+
+To download a zchunk file, run:
+
+    zckdl -s <source> <url of target>
+
+To read a zchunk header, run:
+
+    zck_read_header <file>
 
 #### 参与贡献
 
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
+master分支使用最新的上游版本，如果检测到上游有最新版本发布，先形成issue后再提交对应PR更新，流程如下。
+1.  提交issue
+2.  Fork 本仓库
+3.  新建 Feat_xxx 分支
+4.  提交代码
+5.  新建 Pull Request
 
 
 #### 特技
-- 
Gitee