From 12c6cc186b7468c3b55a2727f1aaff1608cb1993 Mon Sep 17 00:00:00 2001
From: Andrea Fioraldi <andreafioraldi@gmail.com>
Date: Sun, 30 Jun 2024 17:24:02 +0200
Subject: [PATCH] LibAFL QEMU readme (#2351)

---
 libafl_qemu/README.md  | 24 ++++++++++++++++++++++++
 libafl_qemu/src/lib.rs |  1 +
 2 files changed, 25 insertions(+)
 create mode 100644 libafl_qemu/README.md

diff --git a/libafl_qemu/README.md b/libafl_qemu/README.md
new file mode 100644
index 0000000000..7e0a96e2e1
--- /dev/null
+++ b/libafl_qemu/README.md
@@ -0,0 +1,24 @@
+# LibAFL QEMU
+
+LibAFL QEMU is a fuzzing-oriented emulation library that wraps QEMU with a rich API in Rust.
+
+It comes in two variants, usermode to fuzz Linux ELFs userspace binaries and systemmode, to fuzz arbitrary operating systems with QEMU TCG.
+
+## Cite
+
+If you use LibAFL QEMU for your academic work, consider citing the follwing paper:
+
+```
+@InProceedings{libaflqemu:bar24,
+  title        = {{LibAFL QEMU: A Library for Fuzzing-oriented Emulation}},
+  author       = {Romain Malmain and Andrea Fioraldi and Aurélien Francillon},
+  year         = {2024},
+  series       = {BAR 24},
+  month        = {March},
+  booktitle    = {Workshop on Binary Analysis Research (colocated with NDSS Symposium)},
+  location     = {San Diego (USA)},
+  keywords     = {fuzzing, emulation},
+}
+```
+
+
diff --git a/libafl_qemu/src/lib.rs b/libafl_qemu/src/lib.rs
index f92855c0f7..71687c3c5b 100644
--- a/libafl_qemu/src/lib.rs
+++ b/libafl_qemu/src/lib.rs
@@ -2,6 +2,7 @@
 //!
 //! __Warning__: The documentation is built by default for `x86_64` in `usermode`. To access the documentation of other architectures or `systemmode`, the documentation must be rebuilt with the right features.
 /*! */
+#![doc = include_str!("../README.md")]
 #![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
 #![forbid(unexpected_cfgs)]
 // libafl_qemu only supports Linux currently