Add doc on cargo installing qemu

novafacing · Dec 19, 2023 · b29512e · b29512e
1 parent 969374a
commit b29512e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/qemu/README.md b/qemu/README.md
@@ -10,6 +10,7 @@ system and user mode emulators and use them in your code.
   - [Dependencies](#dependencies)
     - [Install Required Dependencies on Ubuntu](#install-required-dependencies-on-ubuntu)
     - [Install Required Dependencies on Fedora](#install-required-dependencies-on-fedora)
+  - [Installation](#installation)
   - [Usage](#usage)
     - [Rust-executable wrapper for user emulator](#rust-executable-wrapper-for-user-emulator)
       - [Cargo.toml](#cargotoml)
@@ -43,6 +44,14 @@ $ sudo dnf install git glib2-devel libfdt-devel \
     pixman-devel zlib-devel bzip2 ninja-build python3
 ```
 
+## Installation
+
+To install QEMU binaries (see feature flags for direction on customizing the build):
+
+```sh
+cargo install qemu --features=binaries,lto,plugins
+```
+
 ## Usage
 
 See the feature flags section for information on enabling targets, but once you have

diff --git a/qemu/src/lib.rs b/qemu/src/lib.rs
@@ -20,6 +20,8 @@
 //! write it to disk and run it, or you can be very efficient and use something like
 //! [memfd-exec](https://crates.io/crates/memfd-exec) to run it from memory directly, or on
 //! a separate thread, whatever!
+//! 
+//! To install with binaries, `cargo install qemu --features=binaries,plugins,lto`
 
 pub const QEMU_VERSION: &str = "8.1.3";