diff options
| -rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -4,8 +4,8 @@ A playground for the [`Kernel Virtual Machine (KVM)`](https://www.kernel.org/doc/html/latest/virt/kvm/index.html) in rust to -learn about KVM and [`rust -ffi`](https://doc.rust-lang.org/stable/std/ffi/index.html). +learn about `KVM`, [`rust +ffi`](https://doc.rust-lang.org/stable/std/ffi/index.html) and `x86_64`. The sources are structured as follows: - [`src/`](./src) provides a small library as abstraction over the raw [KVM @@ -15,6 +15,11 @@ The sources are structured as follows: - [`sysdeps/`](./sysdeps) helper to generate some KVM constants from the system header (executed by [build.rs](./build.rs)). +## Documentation + +Rustdoc for this crate is avalable at +[johannst.github.io/mini-kvm-rs](https://johannst.github.io/mini-kvm-rs/kvm_rs/index.html). + ## Real Mode (16bit) example Runs the [real mode VM](./examples/real_mode.rs) with the [guest program](./guest/guest16.S). |