diff options
| author | johannst <johannes.stoelp@gmail.com> | 2021-06-03 00:55:01 +0200 |
|---|---|---|
| committer | johannst <johannes.stoelp@gmail.com> | 2021-06-03 00:55:01 +0200 |
| commit | 9e148eaa359d01b2881775a84d3386e6988d4e88 (patch) | |
| tree | aebd1a385e2d7812186b81c4d38e5748cc3961fa /README.md | |
| parent | d2e2063cb2b5a82709e9c5188602a9fc0f7dadbd (diff) | |
| download | mini-kvm-rs-9e148eaa359d01b2881775a84d3386e6988d4e88.tar.gz mini-kvm-rs-9e148eaa359d01b2881775a84d3386e6988d4e88.zip | |
README: add link to doc gh page
Diffstat (limited to 'README.md')
| -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). |