Add details on asserting latest version in the dependencies and listing targets.
[rust-lightning] / fuzz / README.md
index 59a4a8f3da2c0cbb740db8b5166276aedded4932..922579232f3f5cae56663bcb530cba48ea6665f0 100644 (file)
@@ -18,10 +18,8 @@ should be more than sufficient.
 To install `honggfuzz`, simply run
 
 ```shell
+cargo update
 cargo install honggfuzz --force
-
-export HFUZZ_BUILD_ARGS="--features honggfuzz_fuzz"
-cargo hfuzz build
 ```
 
 ### Execution
@@ -30,12 +28,19 @@ To run the Hongg fuzzer, do
 
 ```shell
 export CPU_COUNT=1 # replace as needed
+export HFUZZ_BUILD_ARGS="--features honggfuzz_fuzz"
 export HFUZZ_RUN_ARGS="-n $CPU_COUNT --exit_upon_crash"
 
-export TARGET="" # replace with the target to be fuzzed
+export TARGET="msg_ping_target" # replace with the target to be fuzzed
 cargo hfuzz run $TARGET 
 ```
 
+To see a list of available fuzzing targets, run:
+
+```shell
+ls ./src/bin/
+```
+
 ## A fuzz test failed on Travis, what do I do?
 
 You're trying to create a PR, but need to find the underlying cause of that pesky fuzz failure blocking the merge?