AuroraMiddleware/zstd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

minor README.md corrections

Browse Source
This commit is contained in:
inikep 2016-08-25 10:42:49 +02:00
parent ab2f7708c1
commit 637d33566d
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
programs/README.md
View 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.

2
tests/README.md
View 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