diff options
| author | Johannes Stoelp <johannes.stoelp@gmail.com> | 2022-04-16 22:23:30 +0200 |
|---|---|---|
| committer | Johannes Stoelp <johannes.stoelp@gmail.com> | 2022-04-16 22:23:30 +0200 |
| commit | 38cd31ed203999122c500d389de38bb051ce979e (patch) | |
| tree | 20f49a08f571822f78cd7336c1aa653bc83cb357 | |
| parent | 6edfa1ba659319752cd3e0d24566a19de80cdac7 (diff) | |
| download | mini-kvm-rs-38cd31ed203999122c500d389de38bb051ce979e.tar.gz mini-kvm-rs-38cd31ed203999122c500d389de38bb051ce979e.zip | |
README: add doc badge, add requirements
| -rw-r--r-- | README.md | 20 |
1 files changed, 15 insertions, 5 deletions
@@ -1,6 +1,11 @@ # kvm-rs -[](https://github.com/johannst/mini-kvm-rs/actions/workflows/rust.yml) +[![Rust][wf-badge]][wf-output] [![Rustdoc][doc-badge]][doc-html] + +[wf-output]: https://github.com/johannst/mini-kvm-rs/actions/workflows/rust.yml +[wf-badge]: https://github.com/johannst/mini-kvm-rs/actions/workflows/rust.yml/badge.svg +[doc-html]: https://johannst.github.io/mini-kvm-rs/kvm_rs/index.html +[doc-badge]: https://img.shields.io/badge/kvm__rs-rustdoc-blue.svg?style=flat&logo=rust A playground for the [`Kernel Virtual Machine (KVM)`](https://www.kernel.org/doc/html/latest/virt/kvm/index.html) in rust to @@ -11,14 +16,19 @@ The sources are structured as follows: - [`src/`](./src) provides a small library as abstraction over the raw [KVM API](https://www.kernel.org/doc/html/latest/virt/kvm/api.html#api-description). - [`examples/`](./examples) contains example VMs using the library above. -- [`guest/`](./guest) contains the guest source code. -- [`sysdeps/`](./sysdeps) helper to generate some KVM constants from the system - header (executed by [build.rs](./build.rs)). +- [`guest/`](./guest) contains the guest source code which is run inside the VMs. +- [`sysdeps/`](./sysdeps) contains 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). +[johannst.github.io/mini-kvm-rs][doc-html]. + +## Requirements + +- Kernel with `kvm` support and permissions to open `/dev/kvm`. +- Compiler & binuitls for generating the guest images. ## Real Mode (16bit) example |