docs: fuzzing

Signed-off-by: Chojan Shang <[email protected]>
datafuse-extras · Jun 3, 2021 · 0c52491 · 0c52491
1 parent 1e65984
commit 0c52491
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/fuzz/README.md → docs/fuzzing.md b/fuzz/README.md → docs/fuzzing.md
@@ -1,4 +1,4 @@
-# fuzz
+# Fuzzing
 
 ## Installing `honggfuzz`
 
@@ -8,9 +8,12 @@ cargo install honggfuzz
 
 Install [dependencies](https://github.com/rust-fuzz/honggfuzz-rs#dependencies) for your system.
 
-## Fuzzing
+## Running the fuzzer
+
+Running the fuzzer is as easy as running in the `fuzz` directory.
+
+Choose a target:
 
-Choose a target.
 These are `[[bin]]` entries in `Cargo.toml`.
 List them with `cargo read-manifest | jq '.targets[].name'` from the `fuzz` directory.