mirrors/alioth
1
0
Fork 0
mirror of https://github.com/google/alioth.git synced 2024-11-24 04:09:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: update README

Browse source 
Signed-off-by: Changyuan Lyu <changyuanl@google.com>
This commit is contained in:
Changyuan Lyu 2024-11-18 17:49:00 -08:00 committed by Lencerf
parent e493a7cf1c
commit 08aa5a7012
1 changed files with 49 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -5,8 +5,9 @@
![Crates.io Version](https://img.shields.io/crates/v/alioth)
![Crates.io License](https://img.shields.io/crates/l/alioth)
Alioth is an experimental [KVM](https://docs.kernel.org/virt/kvm/api.html)-based
type-2 hypervisor (virtual machine monitor) in Rust implemented from scratch.
Alioth /AL-lee-oth/ is an experimental
[KVM](https://docs.kernel.org/virt/kvm/api.html)-based type-2 hypervisor
(virtual machine monitor) in Rust implemented from scratch.
> [!IMPORTANT]
>
@ -31,7 +32,7 @@ type-2 hypervisor (virtual machine monitor) in Rust implemented from scratch.
--kernel /path/to/vmlinuz \
--cmd-line "console=ttyS0" \
--initramfs /path/to/initramfs \
--mem-size 4G \
--memory size=4G \
--num-cpu 2
```
@ -52,8 +53,8 @@ type-2 hypervisor (virtual machine monitor) in Rust implemented from scratch.
[VFIO/IOMMUFD](https://docs.kernel.org/driver-api/vfio.html#iommufd-and-vfio-iommu-type1).
- Other devices
- serial console: 16450 on `x86_64`, pl011 on `aarch64`,
- [fw_cfg](https://www.qemu.org/docs/master/specs/fw_cfg.html) (QEMU Firmware
Configuration Device),
- [fw_cfg](https://www.qemu.org/docs/master/specs/fw_cfg.html) (QEMU
Firmware Configuration Device),
- [pvpanic](https://www.qemu.org/docs/master/specs/pvpanic.html).
## TODOs