Skip to content

Commit f615b19

Browse files
Serban Iorgabonzini
authored andcommitted
update README.md
- fix typos - use the rust-vmm README.md template Signed-off-by: Serban Iorga <seriorga@amazon.com>
1 parent d556095 commit f615b19

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# vm-memory
22

3-
A library to access the physical memory of a virtual machine.
3+
## Design
44

55
In a typical Virtual Machine Monitor (VMM) there are several components, such
66
as boot loader, virtual device drivers, virtio backend drivers and vhost
@@ -11,14 +11,27 @@ memory of the VM without knowing the implementation details of the VM memory
1111
provider. Thus VMM components based on these traits can be shared and reused by
1212
multiple virtualization solutions.
1313

14-
## Platform Support
14+
The detailed design of the `vm-memory` crate can be found [here](DESIGN.md).
15+
16+
### Platform Support
1517

1618
- Arch: x86, AMD64, ARM64
1719
- OS: Linux/Unix/Windows
1820

19-
## Example
21+
## Usage
22+
23+
Add `vm-memory` as a dependency in `Cargo.toml`
24+
25+
```toml
26+
[dependencies]
27+
vm-memory = "*"
28+
```
29+
30+
Then add `extern crate vm-memory;` to your crate root.
31+
32+
## Examples
2033

21-
- Create a VM physical memory objects in hypervisor specific ways using the
34+
- Creating a VM physical memory object in hypervisor specific ways using the
2235
`GuestMemoryMmap` implementation of the `GuestMemory` trait:
2336

2437
```rust
@@ -31,7 +44,7 @@ fn provide_mem_to_virt_dev() {
3144
}
3245
```
3346

34-
- Consumers access VM's physical memory
47+
- Consumers accessing the VM's physical memory:
3548

3649
```rust
3750
fn virt_device_io<T: GuestMemory>(mem: &T) {
@@ -43,12 +56,6 @@ fn virt_device_io<T: GuestMemory>(mem: &T) {
4356
}
4457
```
4558

46-
## Documentations & References
47-
48-
- [Design of The `vm-memory` Crate](DESIGN.md)
49-
- [TODO List](TODO.md)
50-
- [The rust-vmm Project](https://github.com/rust-vmm/)
51-
5259
## License
5360

5461
This project is licensed under either of

0 commit comments

Comments
 (0)