From c1101b4304ba8a1d372fe65377f4c124ea0a331c Mon Sep 17 00:00:00 2001
From: Alain Emilia Anna Zscheile <fogti+devel@ytrizja.de>
Date: Thu, 5 Dec 2024 19:57:59 +0100
Subject: [PATCH] doc(specctra-core-fuzz): provide README.md with invocation
 example

---
 crates/specctra-core/fuzz/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 crates/specctra-core/fuzz/README.md

diff --git a/crates/specctra-core/fuzz/README.md b/crates/specctra-core/fuzz/README.md
new file mode 100644
index 0000000..cddeba5
--- /dev/null
+++ b/crates/specctra-core/fuzz/README.md
@@ -0,0 +1,12 @@
+# Fuzzer for `specctra-core`
+
+This fuzzer uses [`cargo-fuzz`](https://rust-fuzz.github.io/book/cargo-fuzz/tutorial.html).
+It requires nightly rust to run, and can e.g. be invoked via `cargo fuzz run fuzz_target_1`.
+
+Initialize the corpus via e.g.:
+```
+mkdir -p corpus/fuzz_target_1
+cp -t corpus/fuzz_target_1 $(find ../../../tests | grep \\.dsn)
+```
+before invoking the fuzzer in order to provide the fuzzing with information how
+input should normally look like.