aboutsummaryrefslogtreecommitdiff
path: root/azalea-protocol/fuzz/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'azalea-protocol/fuzz/README.md')
-rw-r--r--azalea-protocol/fuzz/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/azalea-protocol/fuzz/README.md b/azalea-protocol/fuzz/README.md
new file mode 100644
index 00000000..42ae188c
--- /dev/null
+++ b/azalea-protocol/fuzz/README.md
@@ -0,0 +1,10 @@
+Fuzzing for `azalea-protocol`.
+
+## Usage
+
+```sh
+cargo fuzz run clientbound_game # {clientbound,serverbound}_{config,game,handshake,login,status}
+# optionally, add `-s none` for a speedup at the cost of catching less memory safety issues
+# see https://appsec.guide/docs/fuzzing/rust/cargo-fuzz/#addresssanitizer
+```
+