From 637d33566dabd11527b8ccc7b6ef0ca8094a3fcc Mon Sep 17 00:00:00 2001 From: inikep Date: Thu, 25 Aug 2016 10:42:49 +0200 Subject: [PATCH] minor README.md corrections --- programs/README.md | 8 ++++---- tests/README.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/programs/README.md b/programs/README.md index f38e6c49b..4028756c2 100644 --- a/programs/README.md +++ b/programs/README.md @@ -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. diff --git a/tests/README.md b/tests/README.md index 72be1a9b3..0d64c98df 100644 --- a/tests/README.md +++ b/tests/README.md @@ -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