]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
minor README.md corrections
authorinikep <inikep@gmail.com>
Thu, 25 Aug 2016 08:42:49 +0000 (10:42 +0200)
committerinikep <inikep@gmail.com>
Thu, 25 Aug 2016 08:42:49 +0000 (10:42 +0200)
programs/README.md
tests/README.md

index f38e6c49b1aa24922609fce6b2c0c3b6bb811abc..4028756c27f57a75a1097c576c9e54cf60b3e442 100644 (file)
@@ -29,15 +29,15 @@ Dictionary gains are mostly effective in the first few KB. Then, the compression
 will rely more and more on previously decoded content to compress the rest of the file.
 
 Usage of the dictionary builder and created dictionaries with CLI:
-1) Create the dictionary : `zstd --train FullPathToTrainingSet/* -o dictionaryName`
-2) Compress with dictionary: `zstd FILE -D dictionaryName`
-3) Decompress with dictionary: `zstd --decompress FILE.zst -D dictionaryName`
+1. Create the dictionary : `zstd --train FullPathToTrainingSet/* -o dictionaryName`
+2. Compress with dictionary: `zstd FILE -D dictionaryName`
+3. Decompress with dictionary: `zstd --decompress FILE.zst -D dictionaryName`
 
 
 
 #### Benchmark in Command Line Interface
 CLI includes in-memory compression benchmark module for zstd.
-The benchmark is conducted using given filenames which are read into memory and joined together.
+The benchmark is conducted using given filenames. The files are read into memory and joined together.
 It makes benchmark more precise as it eliminates I/O overhead.
 Many filenames can be supplied as multiple parameters, parameters with wildcards or
 names of directories can be used as parameters with the `-r` option.
index 72be1a9b3573ab22ea5e672fb5dcbc92e839d570..0d64c98df05ebafcd43f9d152f3321e797f53343 100644 (file)
@@ -8,7 +8,7 @@ This directory contains the following programs and scripts:
 - `paramgrill` : parameter tester for zstd
 - `test-zstd-speed.py` : script for testing zstd speed difference between commits
 - `test-zstd-versions.py` : compatibility test between zstd versions stored on Github (v0.1+)
-- `zbufftest`  : Test tool to check ZBUFF integrity on target platform
+- `zbufftest`  : Test tool to check ZBUFF (a buffered streaming API) integrity
 - `zstreamtest` : Fuzzer test tool for zstd streaming API