From: Yann Collet <cyan@fb.com>
Date: Wed, 29 Aug 2018 01:19:19 +0000 (-0700)
Subject: added a README
X-Git-Tag: v0.0.29~21^2~9
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d89fa814c17d6b957f2e296cd57c4941839049b3;p=thirdparty%2Fzstd.git

added a README

for documentation
---

diff --git a/contrib/largeNbDicts/README.md b/contrib/largeNbDicts/README.md
new file mode 100644
index 000000000..7eba229a9
--- /dev/null
+++ b/contrib/largeNbDicts/README.md
@@ -0,0 +1,19 @@
+largeNbDicts
+=====================
+
+`largeNbDicts` is a benchmark test tool
+dedicated to the specific scenario of
+dictionary decompression using a very large number of dictionaries,
+which suffers from increased latency due to cache misses.
+It's created in a bid to investigate performance for this scenario,
+and experiment mitigation techniques.
+
+Command line :
+```
+$ largeNbDicts filename [Options]
+Options :
+--clevel=#     : use compression level # (default: 3)
+--blockSize=#  : cut input into blocks of size # (default: 4096)
+--dictionary=# : use # as a dictionary (default: create one)
+--nbDicts=#    : set nb of dictionaries to # (default: one per block)
+```