add octave_tar dependency

CNOCTAVE · Nov 13, 2024 · 534412d · 534412d
1 parent 1f1a4c4
commit 534412d
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 3 deletions.
diff --git a/CITATION b/CITATION
@@ -0,0 +1,10 @@
+引用octave_zstd
+如果你在学术研究中涉及octave_zstd，那么可以按需引用以下内容。
+octave_zstd源码(BibTeX)
+@misc{CNOCTAVE2024, author = {Yu Hongbo, }, title = {octave_zstd}, year = {2024}, howpublished = {\url{https://github.com/CNOCTAVE/octave_zstd}}, }
+
+octave_zstd文档(BibTeX)
+@techreport{CNOCTAVE2024, author = {Yu Hongbo, }, title = {octave_zstd Document}, institution = {BA DU XIN SHANG}, year = {2024}, number = {1}, month = {10}, url = {https://cnoctave.github.io/octave_zstd/index.html}, urldate = {2024-10-07}, }
+
+octave_zstd: Efficient File and String Decompression Utilizing the ZSTD Algorithm(BibTeX)
+@article{https://doi.org/10.6084/m9.figshare.27186048.v1, doi = {10.6084/M9.FIGSHARE.27186048.V1}, url = {https://figshare.com/articles/preprint/octave_zstd_Efficient_File_and_String_Decompression_Utilizing_the_ZSTD_Algorithm/27186048/1}, author = {Yu Hongbo, }, keywords = {Software architecture}, title = {octave_zstd: Efficient File and String Decompression Utilizing the ZSTD Algorithm}, publisher = {figshare}, year = {2024}, copyright = {Creative Commons Attribution 4.0 International} }
diff --git a/PKG_ADD b/PKG_ADD
@@ -0,0 +1 @@
+pkg load octave_tar
diff --git a/docs/index.html b/docs/index.html
@@ -82,6 +82,14 @@
                             项目首页
                         </q-item-section>
                     </q-item>
+                    <q-item clickable v-ripple @click="goToID('#repo_install')">
+                        <q-item-section avatar>
+                            <q-icon name="help" />
+                        </q-item-section>
+                        <q-item-section>
+                            软件源安装
+                        </q-item-section>
+                    </q-item>
                     <q-item clickable v-ripple @click="goToID('#online_install')">
                         <q-item-section avatar>
                             <q-icon name="help" />
@@ -114,6 +122,14 @@
                             依赖库
                         </q-item-section>
                     </q-item>
+                    <q-item clickable v-ripple @click="goToID('#dependencies-package')">
+                        <q-item-section avatar>
+                            <q-icon name="help" />
+                        </q-item-section>
+                        <q-item-section>
+                            依赖包
+                        </q-item-section>
+                    </q-item>
                     <q-item clickable v-ripple @click="goToID('#function_usage')">
                         <q-item-section avatar>
                             <q-icon name="help" />
@@ -155,6 +171,11 @@
                         <q-btn id="homepage" class="title1 text-white bg-primary" stretch flat
                             label="项目首页：https://github.com/CNOCTAVE/octave_zstd" @click="goTo('https://github.com/CNOCTAVE/octave_zstd')"></q-btn>
                         <q-separator></q-separator>
+                        <div id="repo_install" class="title1 q-ma-md text-primary">软件源安装</div>
+                        <p class="q-ma-md">octave_zstd可以通过Octave软件源安装。</p>
+                        <div class="text-h5 q-ma-md text-red-10">通过Octave软件源安装octave_zstd，代码如下：</div>
+                        <p class="q-ma-md">>> pkg install -forge octave_zstd</p>
+                        <q-separator></q-separator>
                         <div id="online_install" class="title1 q-ma-md text-primary">在线安装</div>
                         <p class="q-ma-md">octave_zstd可以在线安装。</p>
                         <div class="text-h5 q-ma-md text-red-10">在线安装octave_zstd，代码如下：</div>
@@ -177,6 +198,13 @@
                         <div class="text-h5 q-ma-md text-red-10">在其他的Linux发行版上的命令有所不同。欢迎广大开发者补充。
                         </div>
                         <q-separator></q-separator>
+                        <div id="dependencies-package" class="title1 q-ma-md text-primary">依赖包</div>
+                        <div class="text-h5 q-ma-md text-red-10">此软件包依赖octave_tar。</div>
+                        <div class="text-h5 q-ma-md text-red-10">安装octave_tar，代码如下：</div>
+                        <p class="q-ma-md">>> pkg install -forge octave_tar</p>
+                        <div class="text-h5 q-ma-md text-red-10">在其他的Linux发行版上的命令有所不同。欢迎广大开发者补充。
+                        </div>
+                        <q-separator></q-separator>
                         <div id="function_usage" class="title1 q-ma-md text-primary">函数用法</div>
                         <div class="text-h5 q-ma-md text-red-10">zstd_compress</div>
                         <p class="q-ma-md">Loadable Function: 0 = zstd_compress(FILENAME, COMPRESSED_FILENAME)</p>
@@ -189,6 +217,16 @@
                         <p class="q-ma-md">输入压缩文件名COMPRESSED_FILENAME和解压缩后的文件名</p>
                         <p class="q-ma-md">DECOMPRESSED_FILENAME。总是返回0。</p>
                         <q-separator></q-separator>
+                        <div class="text-h5 q-ma-md text-red-10">tar_zstd_compress</div>
+                        <p class="q-ma-md">Loadable Function: ret = tar_zstd_compress(SOURCE1, SOURCE2, ... , TAR_ZSTD_FILENAME)</p>
+                        <p class="q-ma-md">输入一个或多个文件或文件夹名SOURCE1, SOURCE2, ...和压缩后的文件名TAR_ZSTD_FILENAME。</p>
+                        <p class="q-ma-md">如果返回0，则代表压缩成功；否则代表压缩失败。</p>
+                        <q-separator></q-separator>
+                        <div class="text-h5 q-ma-md text-red-10">tar_zstd_decompress</div>
+                        <p class="q-ma-md">Loadable Function: 0 = tar_zstd_decompress(TAR_ZSTD_FILENAME, DESTINATION_DIR)</p>
+                        <p class="q-ma-md">输入压缩文件名TAR_ZSTD_FILENAME和解压缩后的文件名DESTINATION_DIR。</p>
+                        <p class="q-ma-md">如果返回0，则代表解压缩成功；否则代表解压缩失败。</p>
+                        <q-separator></q-separator>
                         <div class="text-h5 q-ma-md text-red-10">zstd_compress_string</div>
                         <p class="q-ma-md">Loadable Function: COMPRESSED_STRING = zstd_compress_string(STRING)</p>
                         <p class="q-ma-md">输入字符串STRING，返回压缩后的字符串COMPRESSED_STRING。</p>

diff --git a/inst/tar_zstd_compress.m b/inst/tar_zstd_compress.m
@@ -15,10 +15,10 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {} {} tar_zstd_compress (@var{source1}, @var{source2}, @var{...} , @var{output_filename})
+## @deftypefn {} {} tar_zstd_compress (@var{source1}, @var{source2}, @var{...} , @var{tar_zstd_filename})
 ## 将一个或多个文件或文件夹压缩为.tar.zst文件
 ## @example
-## param: source1, source2, ... , output_filename
+## param: source1, source2, ... , tar_zstd_filename
 ##
 ## return: status
 ## @end example

diff --git a/inst/tar_zstd_decompress.m b/inst/tar_zstd_decompress.m
@@ -15,7 +15,7 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {} {} tar_zstd_decompress (@var{tar_filename}, @var{destination_dir})
+## @deftypefn {} {} tar_zstd_decompress (@var{tar_zstd_filename}, @var{destination_dir})
 ## 将.tar.zst文件解压缩到目标目录下
 ## @example
 ## param: source1, source2, ... , output_filename