Skip to content

Commit

Permalink
[documentation] small README changes (#36)
Browse files Browse the repository at this point in the history
* [documentation] small README changes

Signed-off-by: danbugs <[email protected]>

* Update README.md

Co-authored-by: Simon Davies <[email protected]>
Signed-off-by: danbugs <[email protected]>

---------

Signed-off-by: danbugs <[email protected]>
Co-authored-by: Simon Davies <[email protected]>
  • Loading branch information
danbugs and simongdavies authored Nov 8, 2024
1 parent aeda516 commit 7f74c7f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<div style="display: grid; place-items: center;">
<h1>Hyperlight</h1>
<img src="https://github.com/hyperlight-dev/hyperlight/blob/main/docs/assets/hl-tentative-logo.png" width="150px" />
<img src="https://raw.githubusercontent.com/hyperlight-dev/hyperlight/refs/heads/main/docs/assets/hyperlight-logo.png" width="150px" alt="hyperlight logo"/>
<p>
<strong>Hyperlight is a lightweight Virtual Machine Manager (VMM) designed to be embedded within applications. It enables safe execution of untrusted code within <i>micro virtual machines</i> with very low latency and minimal overhead.
</strong>
Expand Down Expand Up @@ -157,7 +157,7 @@ For examples of guest applications, see the [./src/tests/c_guests](./src/tests/c
- [src/tests/c_guests](./src/tests/c_guests) - This directory contains two Hyperlight Guest programs written in C, which are intended to be launched within partitions as "guests".

- Tests:
- [src/hyperlight-testing](./src/hyperlight_testing/) - Shared testing code for Hyperlight projects build int Rust.
- [src/hyperlight-testing](./src/hyperlight_testing) - Shared testing code for Hyperlight projects build int Rust.

## Try it yourself!

Expand Down Expand Up @@ -220,9 +220,9 @@ If all worked as expected, you should the following message in your console:
Hello, World! I am executing inside of a VM :)
```

If you get the error `Error: NoHypervisorFound` and KVM or mshv is set up then this may be a permissions issue. In bash you can use `ls -l /dev/kvm` or `ls -l /dev/mshv` to check which groups that owns the device and then `groups` to make sure your user is a member of that group.
If you get the error `Error: NoHypervisorFound` and KVM or mshv is set up then this may be a permissions issue. In bash, you can use `ls -l /dev/kvm` or `ls -l /dev/mshv` to check which group owns that device and then `groups` to make sure your user is a member of that group.

For more details on how to verify that KVM is correctly installed and permissions are correct, follow the guide [here](https://help.ubuntu.com/community/KVM/Installation)).
For more details on how to verify that KVM is correctly installed and permissions are correct, follow the guide [here](https://help.ubuntu.com/community/KVM/Installation).

## Contributing to Hyperlight

Expand Down
File renamed without changes
File renamed without changes.

0 comments on commit 7f74c7f

Please sign in to comment.