about summary refs log tree commit diff
path: root/custom_mutators/rust/README.md
diff options
context:
space:
mode:
authorvan Hauser <vh@thc.org>2021-03-01 10:13:31 +0100
committerGitHub <noreply@github.com>2021-03-01 10:13:31 +0100
commit41788950ccb99e8d2bdc274916ce815bf3d5035c (patch)
tree9b2335f357e84e18e4c8259581360923921ca8b2 /custom_mutators/rust/README.md
parent78d96c4dc86ac20e2a6e244017407ccc037ff13b (diff)
parentbd0a23de73011a390714b9f3836a46443054fdd5 (diff)
downloadafl++-41788950ccb99e8d2bdc274916ce815bf3d5035c.tar.gz
Merge pull request #771 from AFLplusplus/stable
v3.10c
Diffstat (limited to 'custom_mutators/rust/README.md')
-rw-r--r--custom_mutators/rust/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/custom_mutators/rust/README.md b/custom_mutators/rust/README.md
new file mode 100644
index 00000000..e2cc38b4
--- /dev/null
+++ b/custom_mutators/rust/README.md
@@ -0,0 +1,11 @@
+# Rust Custom Mutators
+
+Bindings to create custom mutators in Rust.
+
+These bindings are documented with rustdoc. To view the documentation run
+```cargo doc -p custom_mutator --open```.
+
+A minimal example can be found in `example`. Build it using `cargo build --example example_mutator`. 
+
+An example using [lain](https://github.com/microsoft/lain) for structured fuzzing can be found in `example_lain`.
+Since lain requires a nightly rust toolchain, you need to set one up before you can play with it.