about summary refs log tree commit diff
path: root/custom_mutators/rust/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'custom_mutators/rust/README.md')
-rw-r--r--custom_mutators/rust/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/custom_mutators/rust/README.md b/custom_mutators/rust/README.md
new file mode 100644
index 00000000..119ac790
--- /dev/null
+++ b/custom_mutators/rust/README.md
@@ -0,0 +1,9 @@
+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`.
+
+An example using [lain](https://github.com/microsoft/lain) 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.