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

[pcsx_rearmed.git] / deps / libchdr / deps / zstd-1.5.5 / tests / fuzz / seq_prod_fuzz_example / README.md

diff --git a/deps/libchdr/deps/zstd-1.5.5/tests/fuzz/seq_prod_fuzz_example/README.md b/deps/libchdr/deps/zstd-1.5.5/tests/fuzz/seq_prod_fuzz_example/README.md
new file mode 100644 (file)
index 0000000..16fff68
--- /dev/null
+++ b/deps/libchdr/deps/zstd-1.5.5/tests/fuzz/seq_prod_fuzz_example/README.md
@@ -0,0 +1,12 @@
+# Fuzzing a Custom Sequence Producer Plugin
+This directory contains example code for using a custom sequence producer in the zstd fuzzers.
+
+You can build and run the code in this directory using these commands:
+```
+$ make corpora
+$ make -C seq_prod_fuzz_example/
+$ python3 ./fuzz.py build all --enable-fuzzer --enable-asan --enable-ubsan --cc clang --cxx clang++ --custom-seq-prod=seq_prod_fuzz_example/example_seq_prod.o
+$ python3 ./fuzz.py libfuzzer simple_round_trip
+```
+
+See `../fuzz_third_party_seq_prod.h` and `../README.md` for more information on zstd fuzzing.