Skip to content

Commit b5434c1

Browse files
committed
Update README
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
1 parent 45c263b commit b5434c1

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44

55
`hv` is a high level Rust bindings for Hypervisor Framework.
66

7-
Build virtualization solutions on top of a lightweight hypervisor using Rust.
7+
Build virtualization solutions on top of a lightweight hypervisor using Rust:
8+
- Full Hypervisor Framework support.
9+
- Rusty API.
10+
- Supports Apple Silicon.
811

912
[Documentation](https://developer.apple.com/documentation/hypervisor)
1013

@@ -28,6 +31,13 @@ Use the following command to self sign your binary for local development:
2831
$ codesign --sign - --force --entitlements=example.entitlements ./binary
2932
```
3033

34+
### Rust
35+
36+
Developed and tested on latest stable Rust (1.53.0+).
37+
38+
Be sure to have [Xcode](https://developer.apple.com/xcode/) installed and don't forget to `xcode-select --install`,
39+
otherwise `bindgen` may fail to find Hypervisor headers.
40+
3141
## Example
3242

3343
Here is basic "Hello world" example on Apple Silicon:
@@ -41,7 +51,7 @@ hv::Vm::map(load_addr, GUEST_ADDR as _, MEM_SIZE as _, hv::Memory::READ)?;
4151
// Create VCPU
4252
let cpu = hv::Vm::create_cpu()?;
4353

44-
// Register regs
54+
// Set regs
4555
cpu.set_reg(Reg::PC, GUEST_ADDR)?;
4656
cpu.set_reg(Reg::X1, GUEST_RESULT_ADDR)?;
4757

0 commit comments

Comments
 (0)