git subrepo pull (merge) --force deps/libchdr

[pcsx_rearmed.git] / deps / libchdr / deps / zstd-1.5.5 / contrib / externalSequenceProducer / README.md

diff --git a/deps/libchdr/deps/zstd-1.5.5/contrib/externalSequenceProducer/README.md b/deps/libchdr/deps/zstd-1.5.5/contrib/externalSequenceProducer/README.md
new file mode 100644 (file)
index 0000000..c16a170
--- /dev/null
+++ b/deps/libchdr/deps/zstd-1.5.5/contrib/externalSequenceProducer/README.md
@@ -0,0 +1,14 @@
+externalSequenceProducer
+=====================
+
+`externalSequenceProducer` is a test tool for the Block-Level Sequence Producer API.
+It demonstrates how to use the API to perform a simple round-trip test.
+
+A sample sequence producer is provided in sequence_producer.c, but the user can swap
+this out with a different one if desired. The sample sequence producer implements
+LZ parsing with a 1KB hashtable. Dictionary-based parsing is not currently supported.
+
+Command line :
+```
+externalSequenceProducer filename
+```